skills.rest
abdulazeezoj
abdulazeezojCOMMUNITY
Explore all skills by this author →
Website𝕏@abdulazeezojGitHub

document-generate

Generate structured documentation for features, modules, or projects using the Diataxis framework.

Updated Sep 13, 2026
Search Tags:#documentation#technical writing#reference#how-to#tutorial#generate#diataxis
One-click install
npx skills add https://github.com/abdulazeezoj/monovella-poc --skill document-generate-abdulazeezoj
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-generate
Source: https://github.com/abdulazeezoj/monovella-poc/tree/main/.agents/skills/gstack/document-generate
Command: npx skills add https://github.com/abdulazeezoj/monovella-poc --skill document-generate-abdulazeezoj

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing documentation from scratch is slow and often skipped, leaving features, modules, and entire projects undocumented. This Skill produces complete, structured documentation on demand so coverage gaps get filled without a dedicated writing effort. ## Core Features & Use Cases - Diataxis-structured output: Produces tutorials, how-to guides, reference material, and explanations following the Diataxis documentation framework. - Flexible scope: Documents a single feature, a module, or an entire project, and can be invoked standalone or called by /document-release when it finds coverage gaps. - Interactive decision workflow: Uses structured decision briefs to confirm scope, audience, and format before writing. - Use Case: After shipping a new API module with no docs, ask the Skill to document the module and receive a complete tutorial plus reference pages organized by Diataxis type. ## Quick Start Ask the assistant to generate documentation for a specific feature or module in this repository, for example by saying "write docs for the authentication module".

Frequently Asked Questions about document-generate

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

FAQPage Schema
How do I generate documentation for a feature automatically?▼

Invoke the Skill with a request like "document this feature" or "write docs for this project". It reads the relevant source files, confirms scope and audience through decision prompts, then writes complete structured documentation.

What documentation framework does this Skill use?▼

It uses the Diataxis framework, which organizes documentation into four types: tutorials, how-to guides, reference, and explanation. Each generated document is classified into the appropriate type for its purpose.

Can it document an entire project or just single features?▼

Both. The Skill accepts a feature, a module, or an entire project as scope. It can also be called by the /document-release workflow when that process finds documentation coverage gaps.

Does document-generate work in plan mode or headless sessions?▼

Yes. It detects the session kind from its preamble and adapts: interactive sessions get decision questions, spawned sessions auto-choose recommended options, and headless sessions report BLOCKED when a required question cannot be asked.

What are the limitations of generated documentation?▼

Generated docs reflect only what exists in the source code and repository context at generation time. Domain rationale, business decisions, and unwritten conventions still require human review and editing for accuracy.

Related Skills

Explore More Software Engineering Skills→
windyroadwindyroad
4

wr-jtbd:review-jobs

Review staged changes and recent commits against documented JTBD personas and jobs.

Official
Intermediate
RaNDoM6913RaNDoM6913
1

docs-reviewer

Validate documentation freshness, accuracy, and coverage against codebases.

Community
Advanced
webrix-aiwebrix-ai
1

wiki-management

Audit Notion and Google Docs wikis for stale content and broken links.

Official
Intermediate
zorgentechzorgentech

create-adr

Create Architecture Decision Records from pull request metadata and diffs.

Official
Intermediate