Can it help track architectural changes?

Yes, it includes templates for Architecture Decision Records (ADRs) to capture the context, decisions, and consequences of significant design choices.

How does this help with technical writing quality?

The skill enforces the use of active voice, progressive disclosure, and audience awareness, ensuring that documentation is actionable rather than just descriptive.

What documentation types does this skill cover?

It covers project READMEs, inline code comments, API docstrings (JSDoc/Python), changelogs, architecture documentation (C4/ADR), and operational runbooks.

Does it support multiple programming languages?

Yes, it provides specific standards for JavaScript, TypeScript, and Python docstrings, while the general technical writing principles apply to any programming language.

Documentation Standards

Name: Documentation Standards
Author: Claude-Code-Community-Ireland

byClaude-Code-Community-Ireland

•

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

Standardizes software documentation using proven templates and technical writing principles for READMEs, APIs, and architecture.

This skill provides Claude with a comprehensive framework for generating and maintaining high-quality technical documentation across the entire software development lifecycle. It includes structured templates for README files, standardized JSDoc and Python docstring formats, 'Keep a Changelog' conventions, and professional architectural patterns like C4 models and Architecture Decision Records (ADRs). By leveraging these curated standards, Claude ensures that your project's documentation is consistent, accessible, and professional, significantly improving code maintainability and team onboarding speed.

主な機能

01Strict adherence to 'Keep a Changelog' and Semantic Versioning protocols

02Comprehensive README templates with copy-pasteable structures and validation checklists

03Logic-based commenting guidelines focusing on 'the why' rather than 'the what'

04Standardized docstring conventions for JavaScript, TypeScript, and Python (Google Style)

05Structured templates for Architecture Decision Records (ADRs) and operational Runbooks

066 GitHub stars

ユースケース

01Bootstrapping new repositories with professional-grade documentation and contribution guides

02Documenting complex architectural decisions and operational procedures for team transparency

03Refactoring existing codebases to improve readability through standardized docstrings and comments

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add claude-code-community-ireland/claude-code-resources documentation-standards

For use in Claude.ai and ChatGPT

Download Skill

主な機能

01Strict adherence to 'Keep a Changelog' and Semantic Versioning protocols

02Comprehensive README templates with copy-pasteable structures and validation checklists

03Logic-based commenting guidelines focusing on 'the why' rather than 'the what'

04Standardized docstring conventions for JavaScript, TypeScript, and Python (Google Style)

05Structured templates for Architecture Decision Records (ADRs) and operational Runbooks

066 GitHub stars

ユースケース

01Bootstrapping new repositories with professional-grade documentation and contribution guides

02Documenting complex architectural decisions and operational procedures for team transparency

03Refactoring existing codebases to improve readability through standardized docstrings and comments

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add claude-code-community-ireland/claude-code-resources documentation-standards

For use in Claude.ai and ChatGPT

Download Skill