documentation-standards

Enforce Google-style Python docstrings and JSDoc for JavaScript/TypeScript code.

4|Updated Dec 17, 2025
One-click install
npx skills add https://github.com/MatrixFounder/Agentic-development --skill documentation-standards-matrixfounder
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-standards
Source: https://github.com/MatrixFounder/Agentic-development/tree/main/.agent/skills/documentation-standards
Command: npx skills add https://github.com/MatrixFounder/Agentic-development --skill documentation-standards-matrixfounder

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) and references (resource) components.

What problem does it solve?

This Skill ensures that all code is properly documented with clear explanations of why certain logic exists, not just what it does, and that project artifacts are maintained according to standards.

Core Features & Use Cases

  • Enforces Docstring Standards: Mandates Google-style Python docstrings and JSDoc for JavaScript/TypeScript.
  • Comment Guidelines: Differentiates between explaining why code exists versus what it does.
  • Artifact Management: Ensures .AGENTS.md files are kept up-to-date with relative paths.
  • Use Case: Maintain a consistent and understandable codebase across a team by automatically flagging or guiding developers to adhere to these documentation rules during code reviews.

Quick Start

Ensure all new Python functions include Google-style docstrings explaining their purpose.

Frequently Asked Questions about documentation-standards

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

FAQPage Schema
How do I enforce Python docstring standards for my codebase?

To enforce Python docstring standards, mandate Google-style docstrings for all functions, ensuring they explain the 'why' behind the logic, not just the 'what'. This approach maintains consistent documentation rules during code reviews.

What is the best way to standardize JSDoc comments for JavaScript and TypeScript?

Standardizing JSDoc comments requires enforcing specific formats for JavaScript and TypeScript files to explain code purpose clearly. This approach differentiates between explaining why code exists versus what it does.

How do I maintain .AGENTS.md files and project artifacts?

Maintaining .AGENTS.md files involves keeping project artifacts up-to-date and mandating the use of relative paths for internal linking. This skill provides specific guidance on artifact maintenance to ensure project standards are consistently applied.

Does this documentation standard work for both Python and JavaScript projects?

Yes, this documentation standard works for both Python and JavaScript projects by enforcing Google-style Python docstrings and JSDoc for JavaScript/TypeScript. It ensures comprehensive documentation quality across multiple languages within a single team workflow.

Why should code comments explain the why and not just the what?

Code comments should explain the why because understanding the reasoning behind specific logic prevents future errors and maintains codebase clarity. This standard enforces comment guidelines that differentiate between explaining why code exists versus what it does.