aif-docs

Generate a landing README and structured docs/ directory with topic-based pages.

56|3|Updated Mar 17, 2026
One-click install
npx skills add https://github.com/lee-to/ai-workspace --skill aif-docs-lee-to
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: aif-docs
Source: https://github.com/lee-to/ai-workspace/tree/main/.claude/skills/aif-docs
Command: npx skills add https://github.com/lee-to/ai-workspace --skill aif-docs-lee-to

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Project teams often struggle to keep onboarding and knowledge fresh as codebases evolve; this skill automates the creation and maintenance of a lean landing README plus a structured docs/ directory with topic-based pages.

Core Features & Use Cases

  • Landing-page README: provides a concise entry point with quick-start and links to details.
  • Topic-based docs: splits detailed information into docs/ where each file covers a single topic.
  • Navigable structure: enforces prev/next navigation and a See Also section for easy discovery.
  • Update workflow: regenerates documentation in response to project changes or user requests.

Quick Start

Ask me to generate or refresh the project documentation to produce a landing README and topic-based docs.

Frequently Asked Questions about aif-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I auto-generate project documentation for a growing codebase?

Maintain project documentation by applying deterministic templates and update workflows that regenerate docs in response to code changes. This enforces consistent navigation rules, prev/next links, and a See Also section to ensure onboarding knowledge stays current.

What's the best way to structure a docs directory for onboarding?

Use a structured docs/ directory with topic-based pages where each file covers a single topic. This navigable structure enforces prev/next navigation and a See Also section for easy discovery and cross-linking.

How do I keep my README and documentation up-to-date with code changes?

Use an update workflow that regenerates documentation in response to project changes or user requests. This enforces deterministic templates and navigation rules to ensure documentation stays aligned with code changes across multiple topics.

Does this documentation generation approach work for multi-topic projects?

Yes, this approach applies to projects that require clear onboarding and up-to-date documentation across multiple topics. It enforces deterministic templates, navigation rules, and update workflows to ensure documentation stays aligned with code changes.

Can I enforce consistent navigation and cross-links across project docs?

Yes, you can enforce consistent navigation and cross-links by applying deterministic templates and navigation rules across the docs/ directory. This enforces prev/next navigation and a See Also section for easy discovery across all topic-based pages.