Project Docs

Documents

project-docs

Project Docs is an Agent Skill for documents published in the majiayu000/claude-skill-registry repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Project documentation structure — standard proj-[name]/ layout with ADRs, stories, and operations guides. Use when: initializing docs for a new project, recording architecture decisions, or maintaining project knowledge bases.

View on GitHub ↗

QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

Open your project in Codex.
Copy and paste the prompt below.
Review files and risks before approving any action.

Prompt to paste

Inspect the Agent Skill at https://github.com/majiayu000/claude-skill-registry/blob/HEAD/skills/documents/project-docs-cablate-ai-toolkit/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/project-docs, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Project Documentation

Core Principles

Docs are for future you — Good docs let you resume context in 5 minutes after 3 months away
Record decisions, not just results — "We use X" is not enough. Record "why X, not Y"

Project Docs Structure

Each project gets a proj-[name]/ directory:

proj-[name]/
├── SKILL.md                    # Project entry point (concise summary)
└── references/
    ├── _index.md               # Navigation guide
    ├── product/
    │   ├── vision.md           # What problem this project solves
    │   └── principles.md       # Core development principles
    ├── system/
    │   └── overview.md         # System architecture overview
    ├── decisions/
    │   ├── _index.md           # Decision index
    │   ├── adr/                # Architecture Decision Records
    │   └── stories/            # Feature stories
    └── operations/
        ├── quick-nav.md        # Quick navigation
        └── troubleshooting.md  # Common issues & solutions

Initializing a New Project

Create the directory structure above
Fill product/vision.md — What problem does this project solve?
Define product/principles.md — What are the core development principles?
Document system/overview.md — What does the system look like now?
Backfill decisions/adr/ — Record important technical choices already made

See doc-standards.md for ADR format, story format, and naming conventions.

References

File	Content
doc-standards.md	Document formats and templates