/documentation-standards

internal

Category:: Internal Skills

What it is

README structure, Architecture Decision Record (ADR) format, inline code comments (JSDoc / Python docstrings), and API documentation conventions.

Called by

/gaia-dev-story (documentation step)
/gaia-document-project
All stack dev agents, tech-writer, analyst, and PM agents

What it does

Provides the standard README template (Overview, Getting Started, Prerequisites, Installation, Environment Variables, Architecture, Testing, Deployment, Contributing).

Defines ADR format: Title, Status, Context, Decision, Consequences.

Documents inline comment conventions: JSDoc for TypeScript, docstrings for Python.

Specifies API documentation conventions following OpenAPI patterns.

When you will see it surface

When /gaia-dev-story adds documentation during implementation, it follows these standards.
README suggestions in brownfield onboarding reference this template.

Technical notes

Every public function should have a JSDoc/docstring comment.
ADRs use the Status field: proposed, accepted, deprecated, superseded.