skills.rest
igot-ai
igot-aiOFFICIAL
Explore all skills by this author →
WebsiteGitHub

document-project

Scan Unity projects and generate architecture documentation at .output/docs/project-documentation.md.

Updated Aug 27, 2026
Search Tags:#workflow#architecture#unity#documentation#onboarding#codebase#technical-reference
One-click install
npx skills add https://github.com/igot-ai/os-twin --skill document-project-igot-ai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-project
Source: https://github.com/igot-ai/os-twin/tree/main/.agents/skills/roles/narrative-designer/document-project
Command: npx skills add https://github.com/igot-ai/os-twin --skill document-project-igot-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documenting Unity projects, especially brownfield ones, is often manual, inconsistent, and hard to keep up-to-date as code evolves.

Core Features & Use Cases

  • Scans the Unity project (ProjectVersion, manifest, Assets, Editor, Tests) to extract architecture and code structure.
  • Produces a centralized technical reference at .output/docs/project-documentation.md for onboarding and knowledge sharing.
  • Supports iterative updates as the project evolves and new components are added.

Quick Start

Run the Document Project workflow on the Unity project to generate the up-to-date technical reference.

Frequently Asked Questions about document-project

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate documentation for an existing Unity project?▼

You can automatically generate Unity project documentation by scanning the codebase, ProjectVersion, manifest, Assets, and Editor folders. This process extracts architecture and code structure to produce a centralized technical reference for onboarding.

What is the best way to document Unity architecture for new engineers?▼

The best way to document Unity architecture for new engineers is to scan the project systems and code structure automatically. This creates a single source of truth at .output/docs/project-documentation.md for technical reference.

Does automated codebase documentation work for brownfield Unity projects?▼

Yes, automated codebase documentation works for brownfield Unity projects by scanning existing code, architecture, and systems. It supports stepwise discovery and iterative updates as the project evolves and new components are added.

Can I update Unity project documentation as new components are added?▼

You can update Unity project documentation iteratively as the project evolves and new components are added. Running the documentation workflow scans the current codebase and regenerates the technical reference markdown.

What limitations exist when scanning a Unity project for architecture analysis?▼

Limitations of scanning a Unity project for architecture analysis include relying on the codebase structure within ProjectVersion, manifest, Assets, Editor, and Tests. Output is formalized as a markdown file, which may require manual review for complex custom systems.

Related Skills

Explore More Content & Communication Skills→
akiojinakiojin
32

unity-editor-imgui-design

Design Unity Editor IMGUI interfaces for EditorWindow, Custom Inspector, and Property Drawer tooling.

Community
Advanced
LuminairPrimeLuminairPrime
1

technical-writing

Generate structured markdown technical documentation from software project inputs.

Community
Intermediate
leafcoderleafcoder
2

document-sync

Synchronize project documentation with codebase modifications.

Community
Basic
windshockwindshock
3

external-software-analysis

Analyze external binaries and packages for security risks without source access.

Community
Advanced