ai-factory.docs
Docs - Project Documentation Generator
Generate, maintain, and improve project documentation following a landing-page README + detailed docs/ structure.
Core Principles
- README is a landing page, not a manual. ~80-120 lines. First impression, install, quick example, links to details.
- Details go to
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. - No duplication. If information lives in
docs/, README links to it — does not repeat it. Exception: installation command can appear in both (users expect it in README). - Navigation. Every docs/ file has a header line with prev/next links following the Documentation table order:
[← Previous Page](prev.md) · [Back to README](../README.md) · [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. - Cross-links use relative paths. From README:
docs/workflow.md. Between docs:workflow.md(same directory). - Scannable. Use tables, bullet lists, and code blocks. Avoid long paragraphs. Users scan, they don't read.
Workflow
Step 0: Load Project Context
Read .ai-factory/DESCRIPTION.md if it exists to understand:
- Tech stack (language, framework, database)
More from lee-to/ai-factory
aif-skill-generator
Generate professional Agent Skills for AI agents. Creates complete skill packages with SKILL.md, references, scripts, and templates. Use when creating new skills, generating custom slash commands, or building reusable AI capabilities. Validates against Agent Skills specification.
41aif-implement
Execute implementation tasks from the current plan. Works through tasks sequentially, marks completion, and preserves progress for continuation across sessions. Use when user says "implement", "start coding", "execute plan", or "continue implementation".
41aif-security-checklist
Security audit checklist based on OWASP Top 10 and best practices. Covers authentication, injection, XSS, CSRF, secrets management, and more. Use when reviewing security, before deploy, asking "is this secure", "security check", "vulnerability".
39aif-improve
Refine and enhance an existing implementation plan with a second iteration. Re-analyzes the codebase, checks for gaps, missing tasks, wrong dependencies, and improves the plan quality. Use after /aif-plan to polish the plan before implementation, or to improve an existing /aif-fix plan.
37aif-plan
Plan implementation for a feature or task. Two modes — fast (single quick plan) or full (richer plan with optional git branch/worktree flow). Use when user says "plan", "new feature", "start feature", "create tasks".
37aif-commit
Create conventional commit messages by analyzing staged changes. Generates semantic commit messages following the Conventional Commits specification. Use when user says "commit", "save changes", or "create commit".
37