document

Generate Diataxis-compliant documentation from code with cross-linked sections.

1|Updated Jun 9, 2026
One-click install
npx skills add https://github.com/prestarius/jet-skills-stack --skill document-prestarius
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document
Source: https://github.com/prestarius/jet-skills-stack/tree/main/skills/document
Command: npx skills add https://github.com/prestarius/jet-skills-stack --skill document-prestarius

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation of codebases and APIs is often out of date and hard to navigate. This skill generates structured, Diataxis-compliant docs directly from the real code to keep docs accurate, actionable, and discoverable.

Core Features & Use Cases

  • Reference: exact API and surface documentation tied to the code.
  • Explanation: rationale, design decisions, and architecture context.
  • How-to: task-oriented usage guidance for common workflows.
  • Tutorial: end-to-end walkthroughs with runnable examples.
  • Cross-linking: automatic indexes and cross-references to related topics.

Quick Start

Generate a Diataxis-compliant documentation set for a given feature or module by analyzing the codebase and producing Reference, Explanation, How-to, and Tutorial sections.

Frequently Asked Questions about document

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

FAQPage Schema
What is Diataxis-compliant documentation and how does it structure a project?

Diataxis documentation divides project docs into four sections: Reference for exact APIs, Explanation for design rationale, How-to for task guidance, and Tutorial for end-to-end walkthroughs. This framework keeps documentation actionable and discoverable.

How do I generate documentation from real code automatically?

Generate documentation from code by reading the codebase, validating against tests and configuration, and citing exact code surfaces with examples. Target specific modules or APIs to produce structured content across all four Diataxis sections.

Can I create how-to guides and tutorials that validate against my codebase tests?

Yes, how-to guides and tutorials can validate against your codebase tests. The generation process reads the real code, validates content against existing tests and configuration files, and ensures runnable examples remain accurate and executable.

What is the best way to keep API reference documentation up to date?

The best way to keep API reference documentation updated is generating it directly from the real code. Tying exact API and surface documentation to the codebase and validating against tests ensures the output maintains accuracy and reflects current configuration.

Does code analysis documentation generation work without external dependencies?

Yes, code analysis documentation generation works without external dependencies. The process reads the codebase directly, analyzes modules or APIs, and produces structured Diataxis-compliant documentation with cross-linking and a searchable index independently.