doc-dev

Generate standardized markdown templates for specification, design, and TDD plans.

34|5|Updated Oct 18, 2020
One-click install
npx skills add https://github.com/whtoo/How_to_implment_PL_in_Antlr4 --skill doc-dev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-dev
Source: https://github.com/whtoo/How_to_implment_PL_in_Antlr4/tree/main/.claude/skills/doc-dev
Command: npx skills add https://github.com/whtoo/How_to_implment_PL_in_Antlr4 --skill doc-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

技术文档缺乏统一的模板和规范,导致团队之间沟通成本高、实现不一致,评审周期拉长。本 Skill 提供规范文档、设计文档和 TDD 计划三类文档的标准模板和质量标准,帮助团队快速产出高质量文档。

Core Features & Use Cases

  • 规范文档模板: 统一的规格文档结构,确保接口契约清晰,便于对外/对内沟通。
  • 设计文档模板: 提供架构与组件设计的结构化模板,便于多团队协同。
  • TDD计划模板: 任务驱动的测试驱动开发计划模板,提升测试覆盖与回归能力。
  • 使用示例: 在新特性 EP21 的实施中,先创建 EP21_ABI_设计文档.md 按模板填充设计与实现要点。

Quick Start

使用 doc-dev 提供的模板创建新模块的关键文档,例如创建 EP21_ABI_设计文档.md,并按模板填充内容。

Frequently Asked Questions about doc-dev

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

FAQPage Schema
How do I standardize technical documentation across my team?

Standardizing technical documentation uses structured templates and naming conventions to ensure consistency. doc-dev provides specification, design, and TDD plan templates with formal versioning schemes and quality standards, enabling teams to produce aligned documents that reduce review cycles and communication overhead.

What should a specification document include?

A specification document outlines interface contracts and requirements with clear structure. doc-dev's specification template defines consistent sections, naming conventions, and versioning to ensure specifications communicate internal and external requirements reliably and support design handoff.

How do I create a design document that works for multi-team collaboration?

Design documents coordinate architecture and component decisions across teams. doc-dev provides a structured design template with clear sections and quality metrics that enable multiple teams to review, reference, and implement from a single source of truth.

Can I use templates to improve test coverage and regression capability?

Test-driven development plans drive structured testing strategies and improve coverage. doc-dev's TDD plan template provides task-driven structure that helps teams plan test scenarios upfront, track coverage systematically, and strengthen regression test capability.

Why does inconsistent documentation increase implementation risk?

Inconsistent documentation creates misalignment between specification, design, and implementation, extending review cycles and introducing bugs. Standardized templates with clear sections and version tracking ensure teams implement from consistent requirements and catch discrepancies early.

What naming conventions should technical documents follow?

Formal naming conventions make documents discoverable and version-trackable. doc-dev enforces standardized naming patterns alongside markdown templates, versioning schemes, and quality metrics so teams can retrieve, reference, and update documents consistently across projects.