What types of projects is this documentation guide for?

It is language-agnostic and designed for all software projects, ranging from small utilities to complex enterprise applications and microservices.

Does it support Architecture Decision Records (ADRs)?

Yes, it includes specific templates and naming conventions for maintaining a chronological history of significant architectural decisions.

Can I use this for API and Database documentation?

Absolutely. It provides structured formats for documenting endpoints, authentication, database schemas, and entity-relationship diagrams.

How does the document matrix work?

The matrix identifies which documents are required, recommended, or optional based on your project's current state: New, Refactor, Migration, or Maintenance.

Documentation Standard Guide

Name: Documentation Standard Guide
Author: AsiaOstrich

byAsiaOstrich

•

콘텐츠 관리

Standardizes software project documentation through structured templates, requirement matrices, and best practices for READMEs, APIs, and architecture records.

This skill provides a comprehensive framework for creating and maintaining high-quality software documentation across any programming language. It guides developers through the 'Documentation Pyramid' approach, ensuring that every project has a clear entry point and deep technical resources. By using a specialized requirement matrix, the skill identifies exactly which documents—such as READMEs, Architecture Decision Records (ADR), API references, or Migration plans—are necessary based on whether a project is in a new, refactoring, or maintenance phase. It promotes consistency, improves team onboarding, and ensures technical debt is minimized through better information architecture.

주요 기능

01Project-specific document requirement matrix for different development phases

02Hierarchical documentation pyramid for organized information flow

03Comprehensive audit checklist to ensure documentation quality and completeness

0440 GitHub stars

05Standardized templates for README, ARCHITECTURE.md, API.md, and DATABASE.md

06Architecture Decision Record (ADR) framework for tracking design history

사용 사례

01Documenting complex system refactors, migrations, and architectural decisions for long-term maintenance

02Bootstrapping a new software project with a complete and professional documentation suite

03Standardizing documentation structures across a multi-repository engineering organization

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