skills.rest
MadAppGang
MadAppGangOFFICIAL
Explore all skills by this author →
WebsiteGitHub

documentation-standards

Enforce documentation standards with style guides, templates, and anti-pattern detection.

7|4|Updated Feb 26, 2026
Search Tags:#templates#best practices#documentation#markdown#technical writing#style guides
One-click install
npx skills add https://github.com/MadAppGang/magus --skill documentation-standards-madappgang
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-standards
Source: https://github.com/MadAppGang/magus/tree/main/plugins/dev/skills/documentation-standards
Command: npx skills add https://github.com/MadAppGang/magus --skill documentation-standards-madappgang

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive standards, best practices, and templates for creating high-quality technical documentation, ensuring clarity, consistency, and adherence to industry best practices.

Core Features & Use Cases

  • Style Guide Enforcement: Apply rules from Google, Microsoft, and GitLab style guides.
  • Template Library: Utilize ready-to-use templates for READMEs, API docs, tutorials, and more.
  • Anti-Pattern Detection: Identify and correct common AI-generated writing flaws and documentation anti-patterns.
  • Use Case: When writing a new README file for an open-source project, use this Skill to ensure it includes a clear Quick Start, essential features, and links to detailed documentation, following established standards.

Quick Start

Generate a README file for a new project using the provided quick start template.

Frequently Asked Questions about documentation-standards

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

FAQPage Schema
What are the best practices for writing technical documentation?▼

Best practices for technical documentation include using active voice, progressive disclosure, and specific formatting rules. Adhering to industry style guides ensures your technical writing maintains optimal clarity and maintainability.

How do I structure a README file for an open-source project?▼

To structure a README file, use a template that includes a clear Quick Start section, essential features, and links to detailed documentation. This ensures your README meets established documentation standards.

Can I enforce Google or Microsoft style guides for markdown documentation?▼

Yes, you can enforce markdown documentation standards by applying rules from Google, Microsoft, and GitLab style guides. This enforces consistency and adherence to industry best practices across your technical writing.

How do I detect and fix anti-patterns in technical writing?▼

Detect technical writing anti-patterns by checking your content against quality checklists and structured templates. This identifies common flaws, ensuring your documentation uses active voice and progressive disclosure.

Does this approach work for generating API documentation and user tutorials?▼

Yes, this approach works for generating API documentation and user tutorials by utilizing a ready-to-use template library. These templates provide structured content specifically designed for various technical writing use cases.

Related Skills

Explore More Content & Communication Skills→
rethinkhealthrethinkhealth
6

every-style-editor

Apply Every's style rules during a structured line-by-line review.

Official
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
channgchanng
20

docsify

Generate static documentation websites from markdown files with sidebar navigation.

Community
Basic
robotostudiorobotostudio
172

content-modeling-best-practices

Guide structured content modeling and schema design for headless CMS platforms.

Official
Intermediate