Doc WritingSAFE

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

The instruction file, verbatim from the audited commit — this is the text the model reads, and the surface the audit's instruction layer examines. Quoted here so you can judge it without cloning anything.

---
name: doc-writing
description: Generate API documentation from a route manifest. Use when you have a list of discovered routes and need to produce markdown documentation.
allowed-tools: [Read, Write, Glob]
---

# Doc Writing Skill

Generate structured API documentation from a route manifest.

## Input

You will receive a route manifest (JSON array) from the previous pipeline stage.
Each entry contains: method, path, file, line, middleware, type.

## Process

### Step 1: Read Source Code

For each route in the manifest, read the source file to understand:
- Request parameters (path, query, body)
- Response format
- Error handling
- Business logic summary

### Step 2: Generate Documentation

Use the template at `templates/endpoint-doc.md` for each route group.

Group routes by their source file (e.g., all product routes together).

### Step 3: Write Files

Write one markdown file per route group to the `docs/` directory:
- `docs/products-api.md`
- `docs/categories-api.md`
- etc.

## Output

Return a manifest of generated documentation files:

```json
{
  "files_generated": ["docs/products-api.md", "docs/categories-api.md"],
  "routes_documented": 8,
  "routes_skipped": [],
  "warnings": []
}
```

This manifest will be consumed by the next pipeline stage (quality-checking).

SAFEgrade B · trust 89/100 Nothing in the source contradicts what it says it does. Grade A is reserved for packages that have also passed the behavioural sandbox.

What the source does

Filesystem

none-observed

Network

none-observed

Shell

none-observed

Dependencies

pinned

Secrets in source

none-found

Findings (1)

Gates applied: no_behavioural_pass, no_license.