aif-docs

Installation
SKILL.md

Docs - Project Documentation Generator

Generate, maintain, and improve project documentation following a landing-page README + detailed docs-directory structure.

Core Principles

  1. README is a landing page, not a manual. ~80-120 lines. First impression, install, quick example, links to details.
  2. Details go to the resolved docs directory (paths.docs, default: docs/). Each file is self-contained — one topic, one page. A user should be able to read a single doc file and get the full picture on that topic.
  3. No duplication. If information lives in the resolved docs directory, README links to it — does not repeat it. Exception: installation command can appear in both (users expect it in README).
  4. Navigation. Every doc file in the resolved docs directory has a header line with prev/next links following the Documentation table order: [← Previous Page](prev.md) · [Back to README](<docs-to-readme-link>) · [Next Page →](next.md). First page has no prev link; last page has no next link. Every page ends with a "See Also" section linking to 2-3 related pages.
  5. Cross-links use relative paths. From README: link to the resolved docs directory path (for example docs/workflow.md by default). Between doc pages in the same directory: workflow.md.
  6. Scannable. Use tables, bullet lists, and code blocks. Avoid long paragraphs. Users scan, they don't read.

Workflow

Step 0: Load Config & Project Context

FIRST: Read .ai-factory/config.yaml if it exists to resolve:

  • Paths: paths.description, paths.architecture, and paths.docs
Related skills

More from lee-to/ai-factory

Installs
34
GitHub Stars
672
First Seen
Feb 23, 2026