Where does the skill pull information from to write documentation?

It cross-references specification files located in the specs/ directory with the actual implemented logic in the codebase to ensure accuracy.

Can I check which parts of my project are undocumented?

Yes, running the doc skill without arguments generates a coverage report that identifies missing or empty markdown files across your documentation directory.

Does it support markdown build verification?

Yes, the skill automatically runs 'mdbook build' after updates to ensure that all changes are valid and free of broken links.

How does the doc skill differentiate between user and developer docs?

It tailors the language and content based on the target; user docs use plain language and skip code snippets, while developer docs include technical jargon, API references, and Rust code examples.

Automated Documentation Manager

Name: Automated Documentation Manager
Author: pcortellezzi

bypcortellezzi

0•

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

Generates and synchronizes comprehensive technical and user documentation directly from project specifications and source code.

The doc skill automates the complex task of maintaining project documentation by bridging the gap between design specifications and implementation. It intelligently generates both non-technical user guides and deep-dive developer documentation by analyzing spec files and Rust source code. Beyond generation, it provides a full documentation lifecycle management suite, including coverage auditing to identify missing pages, automatic table-of-contents updates via SUMMARY.md, and integrated mdbook build verification to ensure all documentation is error-free and ready for deployment.

主な機能

01Dual-mode generation for non-technical user guides and technical developer docs

02Integrated build verification to detect broken links and formatting errors

03Automated documentation coverage reporting and gap analysis

040 GitHub stars

05Intelligent synchronization between specifications, code, and docs

06Automatic management of mdbook SUMMARY.md structures

ユースケース

01Generating technical API and architecture documentation from Rust crates

02Auditing large repositories to ensure all implemented features are documented

03Maintaining up-to-date user manuals that mirror current feature specifications

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add pcortellezzi/rs_trader doc

For use in Claude.ai and ChatGPT

Download Skill