doc-writer

Apply and validate six standard templates for doc/ Markdown files.

Updated Mar 30, 2026
One-click install
npx skills add https://github.com/MiDouTech/myTapd --skill doc-writer-midoutech
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-writer
Source: https://github.com/MiDouTech/myTapd/tree/main/.claude/skills/doc-writer
Command: npx skills add https://github.com/MiDouTech/myTapd --skill doc-writer-midoutech

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

自动检测并执行对 doc/ 目录中文档的创建与修改操作,确保文档始终遵循六种标准模板并保持一致性。

Core Features & Use Cases

  • 自动应用模板:在文档创建或修改时,自动为 doc/ 下的 .md 文件套用规定的模板类型,确保格式统一。
  • 前置校验:强制检查 YAML 头部(版本、日期、状态等)以及文件命名规范,提升文档质量。
  • 手动与自动触发:支持手动触发(如通过 /doc 指令)以及在检测到文档变更时自动执行。
  • 治理范围:覆盖 spec、design、guide、plan、rule、report 类型,提供快速速查与合规性保障。

Quick Start

以最小化步骤让新文档快速合规:创建或修改 doc/ 下的 .md 文件,系统自动应用模板并提示需完善的头部信息。

Frequently Asked Questions about doc-writer

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

FAQPage Schema
How do I enforce documentation templates automatically for new markdown files?

Automatic template enforcement applies predefined standard templates to markdown files in the doc/ directory upon creation or update, ensuring immediate format compliance without manual formatting.

What is YAML front matter validation for documentation consistency?

YAML front matter validation checks header metadata like version, date, and status in markdown documents to enforce consistency and quality assurance across project specs and guides.

How do I manually trigger documentation format checks using the /doc command?

Manual triggering via the /doc command validates existing markdown files against six standard templates, checking file naming conventions and YAML headers to ensure documentation compliance.

Does documentation consistency enforcement work for different types of project files?

Yes, template enforcement covers six document types: spec, design, guide, plan, rule, and report, providing standardized formatting and compliance checks across various project documentation needs.

Can I use automated template application for team knowledge bases and product specs?

Automated template application is designed for teams managing project documentation, knowledge bases, and product specs, ensuring standardized formats are applied during document creation and edits.

Why does my markdown file fail format validation when updated in the doc directory?

Format validation fails when markdown files in the doc/ directory lack required YAML header metadata like version, date, or status, or violate established file naming conventions.