What is the Diataxis framework used by this skill?

Diataxis is a systematic approach to technical documentation that categorizes content into four distinct types: tutorials for learning, how-to guides for task completion, reference for technical information, and explanation for conceptual understanding.

How does it help with documentation maintenance?

It prevents 'doc rot' by strictly excluding temporal data like status reports and requiring all documents to be linked from a central index for better discoverability.

Where does this skill save the documentation?

Following the 'Eight Rules' of documentation, this skill automatically places all files within a dedicated 'docs/' directory, organized by content type (e.g., docs/tutorials/, docs/reference/).

Does it support document-driven development?

Yes, it includes a specialized 'Retcon' exception that allows you to draft documentation for planned features using placeholders that are updated once implementation is complete.

Can I use this for API documentation?

Yes, the skill is optimized for creating structured API reference material that uses real, project-specific code examples instead of generic placeholders.

Documentation Architect

Name: Documentation Architect
Author: rysweet

byrysweet

0•

学習とドキュメンテーション

Generates high-quality, discoverable software documentation using the Diataxis framework and systematic best practices.

This skill transforms the way developers document their projects by enforcing the Diataxis framework and the 'Eight Rules' of documentation. It automatically organizes content into specialized directories for tutorials, how-tos, reference, and concepts, while ensuring all documents are interlinked for maximum discoverability. By mandating real, runnable code examples and filtering out ephemeral information like status reports, the skill helps teams maintain a permanent, high-value knowledge base that reduces technical debt and improves developer onboarding.

主な機能

01Enforces Diataxis framework (Tutorials, How-To, Reference, Explanation)

02Ensures cross-linking and discoverability via mandatory index management

03Automates document organization and pathing within the docs/ directory

04Filters out temporal data like status reports to prevent documentation rot

05Validates real, runnable code examples to replace 'foo/bar' placeholders

060 GitHub stars

ユースケース

01Converting messy internal notes into structured tutorials and API references

02Implementing document-driven development using [PLANNED] markers for upcoming features

03Creating a comprehensive project README and structured technical documentation site

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add rysweet/azure-tenant-grapher documentation-writing

For use in Claude.ai and ChatGPT

Download Skill