standards-documentation

Apply standardized documentation templates for READMEs, API docs, and code comments.

2|Updated Apr 10, 2024

Search Tags:#templates #documentation #writing #readme #standards #conventions #api-docs

Ready to run

npx skills add https://github.com/gdurandvadas/dotfiles --skill standards-documentation

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: standards-documentation
Source: https://github.com/gdurandvadas/dotfiles/tree/main/config/opencode/skills/standards-documentation
Command: npx skills add https://github.com/gdurandvadas/dotfiles --skill standards-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation inconsistencies across READMEs, API docs, and code comments slow onboarding and obscure decisions. This Skill provides templates, conventions, and clarity principles to standardize documentation.

Core Features & Use Cases

README templates for project setup and guidelines
API documentation patterns and code-comment guidelines
Contributing and licensing templates to keep projects aligned

Quick Start

Draft a standardized README and API documentation template for a new project and adapt it to existing codebases.

Frequently Asked Questions about standards-documentation

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

FAQPage Schema

How do I standardize documentation templates across multiple projects?▼

To standardize documentation templates, you apply consistent clarity principles and structured conventions for READMEs, API docs, and code comments. This ensures readability, maintainability, and smooth contributor onboarding across all projects.

What is the best way to write a README for contributor onboarding?▼

The best way to write a README for onboarding is using structured templates that promote audience-focused writing and current examples. This provides clear project setup guidelines and conventions for new contributors.

How do I create API documentation patterns that maintain readability?▼

You create readable API documentation patterns by applying standardized templates and code-comment guidelines. This enforces consistent clarity principles, ensuring your API docs remain maintainable and audience-focused.

Do I need specific dependencies to apply code comment conventions?▼

No specific dependencies are required to apply code comment conventions. You can integrate these standardized documentation templates and clarity principles directly into your existing projects to improve readability.

Can I adapt documentation conventions to an existing codebase?▼

Yes, you can adapt documentation conventions to an existing codebase. The templates are designed to be drafted for new projects and then adjusted to align with your current code, API docs, and comments.