Can it validate code examples in documentation?

The skill includes specific AI instructions to verify that code examples actually work by reading source code implementations and documenting actual expected outputs to prevent hallucinations.

Does this skill follow specific industry style guides?

Yes, it is based on research from 73 authoritative sources, including the style guides from Google, Microsoft, GitLab, and Red Hat.

What are the 'Anti-Slop' rules in this skill?

Anti-slop rules are constraints that prevent the AI from using banned phrases, marketing superlatives, and monotonous sentence structures, ensuring the resulting documentation sounds professional and human-written rather than generic.

How does it help with user onboarding?

It enforces a mandatory '5-Minute Quick Start' and a three-tier progressive disclosure structure to ensure new users can achieve immediate success before diving into complex details.

Technical Documentation Standards

Name: Technical Documentation Standards
Author: MadAppGang

byMadAppGang

•

학습 및 문서화

Enforces professional industry standards and anti-slop writing rules to create high-quality, human-like technical documentation.

This skill provides a comprehensive framework for generating and auditing technical documentation based on research from industry leaders like Google, Microsoft, and GitLab. It implements the Diataxis framework and strict 'anti-slop' writing rules to eliminate common AI artifacts, ensuring your READMEs, API references, and tutorials are concise, authoritative, and easy to navigate. By prioritizing active voice, progressive disclosure, and verified code examples, it helps developers build documentation that reduces cognitive load and accelerates user success.

주요 기능

01Language-specific documentation tool integration (TSDoc, Sphinx, rustdoc).

02Automated validation for active voice, sentence length, and second-person perspective.

03Five-tier progressive disclosure structure from Quick Start to API Reference.

04Anti-slop engine that eliminates AI-detectable patterns and corporate jargon.

053 GitHub stars

06Requirements for Mermaid diagrams to visualize complex architectural flows.

사용 사례

01Generating new API documentation with validated code examples and expected outputs.

02Restructuring project wikis using the Diataxis framework for better information architecture.

03Auditing existing README files to align with professional technical writing standards.

주요 기능

01Language-specific documentation tool integration (TSDoc, Sphinx, rustdoc).

02Automated validation for active voice, sentence length, and second-person perspective.

03Five-tier progressive disclosure structure from Quick Start to API Reference.

04Anti-slop engine that eliminates AI-detectable patterns and corporate jargon.

053 GitHub stars

06Requirements for Mermaid diagrams to visualize complex architectural flows.

사용 사례

01Generating new API documentation with validated code examples and expected outputs.

02Restructuring project wikis using the Diataxis framework for better information architecture.

03Auditing existing README files to align with professional technical writing standards.