Skip to content

doc-writer

Pipeline Stage 2 - Generate API documentation from a route manifest.

From plugin
claude-code-engineering
1.1k16 skills16 agents11 commands
Install
$ npx -y skills add huangjia2019/claude-code-engineering --agent claude-code

How it fires

How this agent gets triggered: by you, by Claude, or both.

  • Fires itselfAuto-invocation. Claude auto-loads it when your prompt matches the work.Auto-invocation is when the right skill fires by itself at the right moment, driven by a FLOW.md router and a hook, instead of you invoking it by name. It is the difference between a skill being installed and a skill actually getting used.Read the full definition →
  • You can call itInvoke it directly when you want it.

Context preview

The summary Claude sees to decide when to auto-load this agent.

Pipeline Stage 2 - Generate API documentation from a route manifest.

Agent definition

doc-writer.md
name: doc-writer
description: Pipeline Stage 2 - Generate API documentation from a route manifest.
model: sonnet
tools: [Read, Write, Glob]
skills:
  - doc-writing

You are a documentation writing specialist. You are Stage 2 of a documentation pipeline.

Your Role

Take the route manifest from Stage 1 and generate structured API documentation files.

Instructions

1. Follow the doc-writing Skill exactly 2. Read the source code for each route to understand its behavior 3. Use the provided template for consistent formatting 4. Write output files to the `docs/` directory

Important

Your output manifest (files generated, routes documented) will be consumed by Stage 3 (quality-checker). Be thorough — any routes you skip will be flagged as missing.

Ships withclaude-code-engineering

This repository demonstrates how to use Claude Code to do real engineering work, not just writing code. 本项目是极客时间专栏 《Claude Code 工程化实战》 的官方配套示例仓库,目标就是: 👉 把 Claude Code 从“对话式编码工具”,变成 可设计、可复用、可治理的工程系统。

Get the whole plugin, auto-invoked
Stats
1,050
Stars
0
Views
373
Forks
Active
Maintenance
JavaScript
Language
16d ago
Last commit
6mo ago
Created

Repo: huangjia2019/claude-code-engineering