What is the benefit of the companion .md file approach?

Sidecar markdown files keep documentation close to the source code without cluttering files with massive comment blocks, making it easier for both humans and AI to parse interfaces.

How does this support a design-first workflow?

The skill encourages writing documentation and tests before implementation, ensuring the code strictly follows the intended architectural design.

Is this documentation skill language-agnostic?

Yes, it is designed to work across any programming language including Python, TypeScript, Go, Rust, C++, and more.

Where are high-level design decisions stored?

System-wide decisions, workflows, and major feature rationale are stored in a dedicated /docs directory for centralized architectural reference.

Documentation Standards

Name: Documentation Standards
Author: ayazhankadessova

byayazhankadessova

0•

学习与文档

Standardizes project documentation across all architectural layers using a design-first, companion-file approach.

This skill empowers Claude to maintain high levels of code readability and maintainability by enforcing a comprehensive multi-layered documentation strategy. It guides the creation of high-level architecture documents, folder-specific READMEs, and unique sidecar Markdown files for source code and tests, ensuring that the rationale, public APIs, and internal logic of every component are clearly recorded. By integrating documentation into the development workflow, it helps teams reduce technical debt and accelerate developer onboarding through consistent, self-describing codebases.

主要功能

01Source-to-Markdown companion file mapping for clean API references

020 GitHub stars

03Multi-layer documentation framework for architecture, folders, and source files

04Standardized test documentation patterns for better verification visibility

05Automated folder README generation to explain directory layouts

06Design-first workflow integration to document features before implementation

使用场景

01Maintaining up-to-date API references through sidecar markdown files

02Capturing architectural decisions and design trade-offs in a centralized docs directory

03Establishing a unified documentation style for new or legacy codebases

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add ayazhankadessova/essential-skills document-guideline

For use in Claude.ai and ChatGPT

Download Skill