skills.rest
wildbitca
wildbitcaOFFICIAL
Explore all skills by this author →
WebsiteGitHub

common-documentation

Standardize code comments, READMEs, and technical documentation practices.

1|Updated Mar 19, 2026
Search Tags:#documentation#adr#maintenance#docstrings#code-comments#api-docs#readmes
One-click install
npx skills add https://github.com/wildbitca/ai-resources --skill common-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: common-documentation
Source: https://github.com/wildbitca/ai-resources/tree/main/skills/common-documentation
Command: npx skills add https://github.com/wildbitca/ai-resources --skill common-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill codifies and enforces documentation standards for code comments, READMEs, and API/docs to improve maintainability and readability.

Core Features & Use Cases

  • Establishes guidelines for inline comments, docstrings, READMEs, ADRs, and API docs.
  • Provides a maintenance-focused workflow to keep documentation synchronized with code changes.
  • Use case: A development team aligns all new and updated code with consistent commenting and documentation practices.

Quick Start

Apply these rules whenever adding new code or updating documentation to ensure consistency.

Frequently Asked Questions about common-documentation

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

FAQPage Schema
How do I standardize code documentation across a development team?▼

You standardize code documentation by applying consistent guidelines for inline comments, docstrings, READMEs, ADRs, and API docs to improve maintainability and readability across the team.

What is the best way to keep documentation synchronized with code changes?▼

Keep documentation synchronized by applying a maintenance-focused workflow that updates inline comments, docstrings, and technical docs whenever new code is added or existing code is modified.

How do I write consistent docstrings and inline comments for API documentation?▼

Write consistent docstrings and API documentation by following standardized formatting rules and frontmatter requirements that establish clear guidelines for code comments and technical docs.

What should be included in a README and ADR for developer onboarding?▼

Include standardized formatting rules, frontmatter requirements, and maintenance workflows in READMEs and ADRs to provide clear documentation practices that improve developer onboarding and readability.

Does this documentation approach work for existing codebases or only new projects?▼

This documentation approach works for both new and existing codebases by aligning all new and updated code with consistent commenting and documentation practices during ongoing maintenance.

Related Skills

Explore More Software Engineering Skills→
samjhechtsamjhecht
4

initialize-governance

Generate Constitution, Roadmap, and process documentation templates for project governance.

Community
Advanced
cipherstashcipherstash
17

Maintaining Documentation After Code Changes

Synchronize project documentation with code changes using a two-phase workflow.

Official
Intermediate
nanorepublicananorepublica
61

Global Tech Stack

Validate code against centralized global tech stack standards.

Community
Basic
ChegginCheggin
1

documentation-generator

Generate API references, user guides, and changelogs from code and git history.

Community
Advanced