Does it support technical diagrams?

The guide specifically prefers Mermaid.js for diagrams and provides formatting standards for including visual elements within technical documentation.

Can it help with multi-language documentation?

Yes, the skill includes detection for documentation language and supports structures for internationalization, including localized folder paths.

What types of documents does this skill help create?

It provides templates and guidance for README.md, ARCHITECTURE.md, API.md, DATABASE.md, DEPLOYMENT.md, and Architecture Decision Records (ADRs).

How does this skill improve maintainability?

By ensuring architectural decisions are recorded and technical requirements are clearly mapped, it creates a more understandable codebase for future developers.

How does it determine which documents a project needs?

It uses a document requirements matrix that classifies projects as New, Refactor, Migration, or Maintenance to recommend the specific files necessary for that context.

Documentation Guide

Name: Documentation Guide
Author: ValorVie

byValorVie

•

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

Standardizes project documentation using automated structures, content requirements, and best-practice templates for technical specifications.

This skill transforms Claude into a professional technical writer by providing a comprehensive framework for project documentation. It includes a document requirements matrix tailored to project stages—such as new builds, refactors, or migrations—ensuring essential files like READMEs, Architecture Decision Records (ADRs), and API specifications are consistently formatted and high-quality. By enforcing hierarchical organization and naming conventions, it helps maintain a clear 'documentation pyramid' that stays synchronized with the codebase.

主な機能

01Standardized templates for README, ARCHITECTURE, and API documentation

02Automated documentation audit checklist for quality control

033 GitHub stars

04Structured Architecture Decision Record (ADR) framework

05Project type document requirements matrix for tailored guidance

06Hierarchical documentation pyramid for better information architecture

ユースケース

01Auditing existing project files to ensure they meet modern technical standards

02Documenting complex system refactors and architectural changes using ADRs

03Establishing comprehensive documentation for a new software repository

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add valorvie/custom-skills documentation-guide

For use in Claude.ai and ChatGPT

Download Skill