skills.rest
ntluong95
ntluong95COMMUNITY
Explore all skills by this author →
WebsiteGitHub

Documentation Standards

Enforce documentation standards for code comments, READMEs, and architectural records.

Updated Mar 7, 2026
Search Tags:#documentation#technical writing#maintainability#readme#code comments#docstrings
One-click install
npx skills add https://github.com/ntluong95/agent-skills-statistics --skill documentation-standards-ntluong95
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Documentation Standards
Source: https://github.com/ntluong95/agent-skills-statistics/tree/main/.github/skills/common/documentation
Command: npx skills add https://github.com/ntluong95/agent-skills-statistics --skill documentation-standards-ntluong95

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures your code is understandable and maintainable by enforcing clear, consistent documentation practices across comments, READMEs, and architectural documents.

Core Features & Use Cases

  • Clear Code Comments: Guides on writing "why" comments and using TODOs effectively.
  • Comprehensive READMEs: Outlines essential sections for onboarding and maintainability.
  • Architectural Documentation: Specifies the use of ADRs and diagrams for complex systems.
  • Use Case: When adding a new feature, use this Skill to ensure all new code is properly commented and the project's README is updated with usage instructions.

Quick Start

Follow the documentation standards to add inline comments explaining the intent of the new function.

Frequently Asked Questions about Documentation Standards

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What should be included in a comprehensive README for code maintainability?▼

A comprehensive README for maintainability requires specific essential sections for onboarding and project usage. It should outline usage instructions and architectural context to ensure the codebase remains understandable for future developers.

How do I write effective code comments and docstrings?▼

Effective code comments and docstrings should focus on explaining the "why" behind the logic rather than the mechanics. You should also use TODOs effectively to mark areas requiring future attention or incomplete implementations.

When do I need architectural decision records and diagrams?▼

Architectural decision records (ADRs) and diagrams are needed when documenting complex systems. They specify architectural choices and system structures, ensuring maintainability and clear communication of structural decisions across the development team.

How do I enforce consistent documentation standards across a project?▼

You can enforce consistent documentation standards by requiring adherence to specific guidelines for inline comments, docstrings, README content, and ADRs. This ensures high-density documentation practices across the entire codebase.

What is the best way to document code intent when adding a new feature?▼

The best way to document code intent for a new feature is to add inline comments explaining the function's purpose and update the project README. This maintains high-density standards and keeps usage instructions current.

Related Skills

Explore More Software Engineering Skills→
k1lgork1lgor
2

doc-writer

Explains code paths and generates READMEs, inline comments, docstrings in Markdown format.

Community
Intermediate
Mte90Mte90
51

Documentation Standards

Enforce documentation standards for code comments, READMEs, and architectural docs.

Community
Basic
KrystianYCSilvaKrystianYCSilva

markdown-expert

Create Markdown documentation with Mermaid diagrams and GFM tables.

Community
Intermediate
HomericIntelligenceHomericIntelligence
18

generate-api-docs

Generates API reference documentation from Python docstrings using pdoc or Sphinx.

Official
Intermediate