skills.rest
1t1sCooL
1t1sCooLCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

aif-docs

Generate and maintain project documentation with a lean README and topic-split docs directory.

Updated Jun 5, 2026
Search Tags:#documentation#markdown#onboarding#technical writing#readme#html export#docs generator
One-click install
npx skills add https://github.com/1t1sCooL/zazyvala-bot --skill aif-docs-1t1scool
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: aif-docs
Source: https://github.com/1t1sCooL/zazyvala-bot/tree/main/.cursor/skills/aif-docs
Command: npx skills add https://github.com/1t1sCooL/zazyvala-bot --skill aif-docs-1t1scool

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Project documentation often becomes a bloated README or scattered markdown files that are hard to navigate and quickly go stale. This Skill generates and maintains a structured documentation set: a lean landing-page README plus detailed topic pages in a docs directory, with consistent navigation and review checklists. ## Core Features & Use Cases - Documentation Generation: Creates a ~80-120 line README landing page plus self-contained topic pages (getting-started, architecture, API, configuration) with prev/next navigation and See Also sections. - Split & Consolidation: Splits oversized READMEs into docs pages and consolidates scattered root-level markdown files (CONTRIBUTING.md, DEPLOYMENT.md) into the docs directory with user approval. - Audit & HTML Export: Audits existing docs for broken links, stale content, and standards compliance, and optionally generates a static HTML site via the --web flag. - Use Case: A developer with a 300-line README asks to reorganize it; the Skill proposes a split, moves detailed sections into docs/ pages with navigation, rewrites the README as a landing page, and runs a review checklist. ## Quick Start Ask the assistant to generate or update the project documentation, optionally passing the --web flag to also produce an HTML version.

Frequently Asked Questions about aif-docs

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

FAQPage Schema
How do I generate project documentation from scratch?▼

Invoke the skill with a request like "create docs" or "generate readme". It analyzes your codebase, proposes documentation topics such as getting-started and architecture, and generates a lean README plus docs pages after your approval.

How to split a long README into multiple documentation pages?▼

The skill detects READMEs over 150 lines and proposes a split: landing content stays in README while detailed sections move to docs/ pages like getting-started.md and configuration.md. It verifies no content is lost during the split.

Can I generate an HTML version of my markdown documentation?▼

Yes, pass the --web flag. The skill converts README.md and all docs pages into a static HTML site in docs-html/ using a built-in template with navigation, and adds docs-html/ to .gitignore.

Does the documentation generator support languages other than English?▼

Yes. It reads language settings from .ai-factory/config.yaml (language.ui and language.artifacts) and matches the project's existing language, so a Russian README produces Russian documentation.

Will the skill modify or delete my existing documentation files?▼

Never without approval. It always shows a plan first, asks before moving or merging root-level markdown files, and only deletes originals after you confirm the content exists in the new location.

Related Skills

Explore More Software Engineering Skills→
real-casereal-case

readme

Generate or update README.md files based on actual codebase analysis.

Community
Basic
DJ2695DJ2695

flutter-app-release

Automates end-to-end Flutter release pipelines for iOS, Android and Web hosting.

Community
Advanced
NotysotyNotysoty
9

Documentation Gap Finder

Audit codebases and docs folders to surface undocumented or outdated areas.

Community
Advanced
beelabstudiobeelabstudio

documentation-writer

Creates and maintains technical documentation, API docs, README files, and user guides.

Official
Basic