doc-style

Enforce structural and metadata standards for technical markdown documentation.

2|Updated Apr 21, 2026
One-click install
npx skills add https://github.com/dd-xiaozhi/dev-agent-flow --skill doc-style-dd-xiaozhi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-style
Source: https://github.com/dd-xiaozhi/dev-agent-flow/tree/main/.claude/skills/doc-style
Command: npx skills add https://github.com/dd-xiaozhi/dev-agent-flow --skill doc-style-dd-xiaozhi

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the inconsistency and lack of structure in project documentation by enforcing a rigorous, standardized writing style for rules, protocols, and technical specifications.

Core Features & Use Cases

  • Standardized Formatting: Automatically applies section markers, table-first data organization, and specific Chinese-English mixed conventions.
  • Quality Control: Implements a 12-point iron rule set and an anti-pattern checklist to ensure documentation is maintainable, traceable, and clear.
  • Use Case: When drafting a new ADR or technical protocol, this Skill ensures the document includes necessary metadata, commit history, and clear relationship mapping to existing project rules.

Quick Start

Invoke the doc-style skill to review and format the current markdown document according to project standards.

Frequently Asked Questions about doc-style

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

FAQPage Schema
How do I standardize technical markdown files for project documentation?

Standardizing technical markdown files involves enforcing structural, stylistic, and metadata requirements. This Skill applies section markers, table-first data organization, and traceability markers like commit hashes for documentation consistency.

What is the best way to enforce a style guide for ADRs and technical protocols?

Enforcing a style guide for ADRs and protocols requires implementing a rigorous rule set and anti-pattern checklist. This ensures documents include necessary metadata, commit history, and clear relationship mapping to existing project rules.

How do I format a CHANGELOG entry to ensure traceability in the development workflow?

Formatting a CHANGELOG entry for traceability requires mandatory commit hashes and standardized section markers. This ensures every update within the development workflow remains maintainable and clearly mapped to project rules.

Does this documentation standardization approach support Chinese-English mixed text conventions?

Yes, this documentation standardization approach explicitly supports Chinese-English mixed conventions. It automatically applies these specific formatting rules alongside table-first data organization when processing technical markdown files.

Why does my project documentation fail the anti-pattern checklist during review?

Project documentation fails the anti-pattern checklist when it lacks mandatory metadata, proper section markers, or clear relationship mapping to existing rules. The standardization process enforces a 12-point iron rule set to eliminate these maintainability issues.

Can I use this markdown style guide enforcement for rules and technical specifications?

Yes, you can use this markdown style guide enforcement for rules and technical specifications. It standardizes document creation and maintenance by applying rigorous structural formatting, metadata requirements, and traceability markers.