doc-writer

Validate Markdown documents under doc/ against six standardized templates.

2|1|Updated Dec 10, 2025
One-click install
npx skills add https://github.com/inernoro/prd_agent --skill doc-writer-inernoro
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-writer
Source: https://github.com/inernoro/prd_agent/tree/main/.claude/skills/doc-writer
Command: npx skills add https://github.com/inernoro/prd_agent --skill doc-writer-inernoro

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The Doc Writer guards document creation and modification in the doc/ directory, ensuring every file conforms to one of six standardized templates and valid header formats.

Core Features & Use Cases

  • Enforces 6 template types (spec, design, plan, rule, guide, report) for every doc under doc/.
  • Validates file naming conventions and standard frontmatter (name and description).
  • Triggers automated checks on new or modified docs and offers quick-reference via /doc.
  • Supports multilingual trigger words (e.g., 写文档, 新建文档, 文档模板, /doc) for accessibility.

Quick Start

Create a new document under doc/ using one of the six templates by issuing /doc.

Frequently Asked Questions about doc-writer

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

FAQPage Schema
How do I enforce consistent documentation templates across my project?

You can enforce consistent documentation by applying six standardized templates to Markdown files under a doc/ directory. It validates frontmatter, filename patterns, and header formatting to ensure uniform guidelines across new and modified documents.

What are the best standard templates for managing markdown documentation?

Standard templates for managing markdown documentation include spec, design, plan, rule, guide, and report formats. Each template enforces specific header formatting and frontmatter requirements like name and description for better doc-management consistency.

How do I validate frontmatter and naming conventions for markdown files?

To validate frontmatter and naming conventions, apply automated checks to new or modified markdown files. This process vets required frontmatter fields like name and description while ensuring filenames match established pattern guidelines.

Can I use automated checks to ensure my docs follow predefined guidelines?

Yes, you can use automated checks to ensure docs follow predefined guidelines. By triggering checks upon document creation or modification, the system validates template selection, header formatting, and required frontmatter fields automatically.

Does the template enforcement support multilingual commands for creating docs?

Yes, template enforcement supports multilingual commands for creating docs. You can trigger document creation and template guidance using multilingual phrases like 写文档 or 新建文档, alongside standard command inputs like /doc.