Does it support diagramming tools?

Yes, the guide specifically recommends using Mermaid.js for diagrams to ensure they are version-controllable and easy to maintain within Markdown.

Can this skill audit my existing documentation?

Yes, it includes an audit checklist to verify if your current documentation meets industry standards for installation, usage, and maintenance info.

What is the Documentation Pyramid?

The Documentation Pyramid is a structural hierarchy that organizes info from entry-level overview (README) down to deep technical details (ADR/Migration) for maximum readability.

How does this skill help with project migrations?

It provides a specific requirement matrix for migrations, ensuring MIGRATION.md and ADR files are created to document the transition plan and decision logic.

Professional Documentation Standards (CN)

Name: Professional Documentation Standards (CN)
Author: AsiaOstrich

byAsiaOstrich

•

学习与文档

Standardizes software project documentation through structured templates, requirement matrices, and best-practice organizational patterns.

This skill provides a comprehensive framework for creating and maintaining high-quality technical documentation in software projects. It features a specialized document matrix that identifies necessary files—such as README, ARCHITECTURE, and API guides—based on project types like new development, refactoring, or migrations. By implementing a 'Documentation Pyramid' hierarchy and providing standardized templates for ADRs and database schemas, it ensures that project knowledge remains accessible, consistent, and audit-ready for both human developers and AI collaborators.

主要功能

01Hierarchical 'Documentation Pyramid' for organizational clarity

02Comprehensive documentation audit checklist for quality assurance

03Architecture Decision Record (ADR) framework and templates

04Project-specific documentation requirement matrix (New/Refactor/Migrate/Maintain)

05Standardized templates for README, API, Architecture, and Database files

0640 GitHub stars

使用场景

01Standardizing technical documentation across multiple repositories in an engineering organization

02Ensuring critical architectural decisions are captured during complex system refactors

03Setting up a professional documentation structure for a new open-source or internal project

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add asiaostrich/universal-dev-standards documentation-guide

For use in Claude.ai and ChatGPT

Download Skill