aif-docs

Generate and maintain project documentation with topic-based pages and See Also links.

Updated Mar 22, 2026
One-click install
npx skills add https://github.com/afterwork/arra-aif --skill aif-docs-afterwork
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: aif-docs
Source: https://github.com/afterwork/arra-aif/tree/main/.cursor/skills/aif-docs
Command: npx skills add https://github.com/afterwork/arra-aif --skill aif-docs-afterwork

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates and maintains project documentation with a lean landing page (README) plus a structured docs/ directory split by topics, improving onboarding and long-term knowledge management.

Core Features & Use Cases

  • Creates a concise landing README that highlights project purpose and quick links
  • Splits long documentation into topic-based pages under docs/ with navigation, prev/next, and See Also
  • Supports auditing and updating existing docs, including optional HTML output (--web)
  • Helps consolidate scattered root Markdown files into docs/ when needed

Quick Start

Run the documentation generator to create a lean landing README and topic-based docs for your project.

Frequently Asked Questions about aif-docs

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

FAQPage Schema
How do I generate structured project documentation from markdown files?▼

Generate structured project documentation by creating a lean landing README and splitting content into topic-based pages under a docs directory with navigation headers and See Also links.

What is the best way to organize scattered root markdown files into navigable docs?▼

Consolidate scattered root markdown files by refactoring them into a structured docs directory, applying template-driven pages with prev/next navigation and See Also sections for improved onboarding.

Can I export markdown documentation to HTML web pages?▼

Yes, you can export markdown documentation to HTML output using the optional --web flag while validating links and refactoring content as needed.

How do I audit and update existing project documentation with broken links?▼

Audit and update existing documentation by validating links, refactoring content, and restructuring pages into a concise landing README with topic-based navigation.

Does this documentation generator work for software projects that need a concise README?▼

Yes, this documentation generator works for software projects and teams wanting a concise README plus structured navigable documentation organized by topics and See Also links.

What are the limitations of template-driven documentation generation?▼

Template-driven documentation generation focuses on markdown projects needing topic-based pages with navigation and See Also links; it validates links and refactors content but does not support non-markdown formats.