文档编写器

Create and update numbered task documents from DOC_TEMPLATE.md in docs/planned and docs/completed.

Updated Sep 5, 2021
One-click install
npx skills add https://github.com/a747895159/spring-cloud-study-alibaba --skill -a747895159
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: 文档编写器
Source: https://github.com/a747895159/spring-cloud-study-alibaba/tree/main/.agent/skills/doc-writer
Command: npx skills add https://github.com/a747895159/spring-cloud-study-alibaba --skill -a747895159

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

此技能通过读取 DOC_TEMPLATE.md 和现有仓库材料,自动创建或更新带编号的任务文档,减少重复工作和人为错误。

Core Features & Use Cases

  • 自动化文档生成与更新:依据 DOC_TEMPLATE.md 结构为 docs/planned/XX-.md 与 docs/completed/XX-.md 创建或刷新文档。
  • 结构化任务记录:强制执行统一的元数据、目标、前置条件、步骤、验收标准等字段。
  • Use Case: 当新任务加入仓库时自动创建对应的计划与完成文档模板并归档。

Quick Start

按照仓库现有内容和 DOC_TEMPLATE.md 的结构,创建或更新 docs/planned/XX-.md 和 docs/completed/XX-.md。

Frequently Asked Questions about 文档编写器

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

FAQPage Schema
How do I automatically generate numbered task documents in a repository?

To automatically generate numbered task documents, this skill reads repository context and DOC_TEMPLATE.md to create structured markdown files under docs/planned and docs/completed. It enforces naming conventions and metadata fields for each task.

Can I update existing planned and completed markdown files as tasks evolve?

Yes, you can update existing planned and completed markdown files as tasks evolve. The skill refreshes documents in docs/planned and docs/completed by re-reading repository context and applying the DOC_TEMPLATE.md structure.

Do I need a specific markdown template to automate repository documentation?

Yes, you need a DOC_TEMPLATE.md file to automate repository documentation. The skill requires this template alongside access to PLAN.md, AGENTS.md, and existing task documents to enforce consistent structure and naming conventions.

What is the best way to enforce consistent metadata and structure across task documents?

The best way to enforce consistent metadata and structure is using DOC_TEMPLATE.md with this skill. It automatically applies predefined fields like objectives, prerequisites, steps, and acceptance criteria to every generated or updated task document.

How does repository context help structure task documentation?

Repository context helps structure task documentation by providing existing materials from PLAN.md, AGENTS.md, and current task files. The skill analyzes these inputs to maintain numbering sequences and ensure new documents match the established project conventions.

Are there limitations when creating task documents without existing repository files?

Yes, creating task documents without existing repository files is limited. The skill requires DOC_TEMPLATE.md for structure and relies on accessing PLAN.md, AGENTS.md, and existing task documents to correctly enforce naming conventions and archive tasks.