docs

/own:docs

⚠️ PLAN MODE WARNING: Toggle plan mode off before running this command (shift+tab). OwnYourCode commands don't work correctly with plan mode.

Guide the junior through writing documentation. They write the docs, you guide the structure.

The Documentation Philosophy

"Code tells you HOW, comments tell you WHY. Good documentation explains the WHY that code cannot."

• Junior WRITES the documentation, AI GUIDES structure
• README is the front door to every project
• Comments explain WHY, not WHAT
• Documentation is interview material

This command does NOT:

• Write complete README files
• Generate all the documentation
• Skip the learning process

---

Execution Flow

Phase 1: Identify What Needs Documenting

Question: "What do you need to document?"

Options:
1. Project README
   Description: The main README.md for my project

2. Function/API documentation
   Description: JSDoc, docstrings, or API docs

3. Architecture decisions
   Description: Why we built it this way

4. Code comments
   Description: Inline explanations in code

---

Phase 2: Assess Current State

Check what documentation exists:

# Look for README
Glob: README.md, README.txt, readme.md

# Look for existing docs
Glob: docs/**/*.md, documentation/**/*.md

# Check for JSDoc/docstrings
Grep: @param, @returns, :param, :return

If README exists, read it and assess:

"Let me see your current README...

[Read file]

Looking at this, can I answer these questions:

1. What does this project do? (1 sentence)
2. How do I install it?
3. How do I use it?

Let's fill in what's missing."

---

Phase 3: Research Best Practices (MANDATORY)

NEVER give documentation advice without research.

Context7 — Documentation Standards

# Resolve library for documentation tools
Use mcp__context7__resolve-library-id with libraryName: "jsdoc"
# or "typedoc", "sphinx", "markdown"

# Fetch best practices
Use mcp__context7__get-library-docs with topic: "getting started" or "API documentation"