skills.rest
terraphim
terraphimOFFICIAL
Explore all skills by this author →
WebsiteGitHub

documentation

Generate and maintain Rust project documentation as Markdown files.

Updated Aug 23, 2026
Search Tags:#architecture#documentation#readme#contributing#rustdoc#api-docs
One-click install
npx skills add https://github.com/terraphim/terraphim-skills --skill documentation-terraphim
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/terraphim/terraphim-skills/tree/main/skills/documentation
Command: npx skills add https://github.com/terraphim/terraphim-skills --skill documentation-terraphim

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation debt in Rust projects leads to misaligned API docs, outdated READMEs, and missing contributor guidance. This Skill provides a structured approach to generate, maintain, and validate Rust project documentation that stays in sync with code.

Core Features & Use Cases

  • API Documentation Alignment: generates rustdoc-compliant docs that reflect current code.
  • README and CONTRIBUTING: produces high-quality READMEs and contribution guidelines.
  • Architecture & Guides: creates architecture diagrams and contributor-facing guides.
  • Quality & Consistency: enforces formatting and style standards across docs.

Quick Start

Run the documentation skill to scaffold and refresh docs from your Rust project. For example, generate API docs and a README, then validate with cargo doc and link checks

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I generate Rust documentation that stays aligned with my codebase?▼

To generate Rust documentation that stays aligned with your codebase, you can use this Skill to produce rustdoc-compliant API docs, READMEs, and architecture guides that reflect your current code and pass cargo doc checks.

What is the best way to automate README and CONTRIBUTING file creation for Rust projects?▼

The best way to automate README and CONTRIBUTING file creation for Rust projects is to run this Skill, which enforces quality standards and produces high-quality contribution guidelines tailored to your codebase.

Can I use this Skill to create architecture guides for my Rust codebase?▼

Yes, you can use this Skill to create architecture guides for your Rust codebase, as it automatically generates architecture diagrams and contributor-facing guides while enforcing formatting and style consistency.

How do I validate generated Rust API docs for publication?▼

To validate generated Rust API docs for publication, this Skill produces Markdown files suitable for running cargo doc checks and link checks, ensuring your documentation meets quality and publication standards.

Does this documentation generator work without external dependencies?▼

Yes, this documentation generator works without external dependencies, allowing you to scaffold and refresh docs directly from your Rust project without requiring additional modules or component installations.

Related Skills

Explore More Software Engineering Skills→
ashtonianashtonian
2

dependency-audit

Audit software dependencies across Go, Node.js, Python, Rust, and containers.

Community
Intermediate
furiosa-aifuriosa-ai
1

write-docs

Generate Markdown documentation from requirements files with inline citations.

Official
Advanced
CallMeLuigiv2CallMeLuigiv2

coding-guidelines

Enforce Rust naming, formatting, and lint conventions during code reviews.

Community
Basic
RigohlRigohl

rust-documentation

Generate Rust crate and module documentation following rustdoc conventions.

Community
Intermediate