write-docblocks

Name: write-docblocks
Author: aaddrick

120stars16forks

How to install write-docblocks?

aaddrick/claude-pipeline/write-docblocks

$npx -y skills add aaddrick/claude-pipeline --skill write-docblocks

Installs into the current project.

Summary

Use when documentation coverage is low, after composer docs:coverage shows gaps, or when asked to batch-write PHPDoc blocks across multiple files

Files · 1

View on GitHub

SKILL.md

1	# Write Docblocks
2
3	## Overview
4
5	Batch-process PHPDoc documentation gaps by running `composer docs:coverage:missing` and dispatching parallel phpdoc-writer subagents.
6
7	Core principle: Process files in batches of 5 subagents for efficient parallel documentation without overwhelming the system.
8
9	## When to Use
10
11	- Documentation coverage below target (80% classes, 75% methods)
12	- After creating multiple new services, controllers, or models
13	- When `composer docs:coverage:missing` shows many files needing docs
14	- User requests batch PHPDoc writing
15
16	## Workflow
17
18	```dot
19	digraph write_docblocks {
20	rankdir=TB;
21
22	start [label="Run composer docs:coverage:missing" shape=box];
23	parse [label="Parse output for file paths" shape=box];
24	check [label="Files remaining?" shape=diamond];
25	batch [label="Take next 5 files" shape=box];
26	dispatch [label="Dispatch 5 phpdoc-writer\nsubagents in parallel" shape=box];
27	wait [label="Wait for batch to complete" shape=box];
28	done [label="Run composer docs:coverage\nto verify improvement" shape=box];
29
30	start -> parse -> check;
31	check -> batch [label="yes"];
32	check -> done [label="no"];
33	batch -> dispatch -> wait -> check;
34	}
35	```
36
37	## Execution Steps
38
39	### 1. Get Missing Files
40
41	```bash
42	composer docs:coverage:missing 2>&1 \| sed 's/\x1b\[[0-9;]*m//g' \| grep '\.php$'
43	```
44
45	This strips ANSI codes and extracts just file paths like:
46	```
47	Console/Commands/ProcessDataCommand.php
48	Http/Controllers/AuthController.php
49	Services/AuthService.php
50	```
51
52	### 2. Process in Batches of 5
53
54	For each batch of 5 files, dispatch phpdoc-writer subagents in parallel using a single message with multiple Task tool calls:
55
56	```
57	Task(subagent_type="phpdoc-writer", prompt="Write PHPDoc blocks for app/Console/Commands/ProcessDataCommand.php - read the file, understand its purpose, and add comprehensive docblocks for the class and all undocumented methods.")
58
59	Task(subagent_type="phpdoc-writer", prompt="Write PHPDoc blocks for app/Http/Controllers/OAuthController.php - read the file, understand its purpose, and add comprehensive docblocks for the class and all undocumented methods.")
60
61	// ... 3 more in same message
62	```
63
64	CRITICAL: All 5 Task calls MUST be in a single assistant message to run in parallel.
65
66	### 3. Wait for Batch Completion
67
68	Wait for all 5 subagents to complete before starting the next batch. This prevents resource exhaustion while maintaining parallelism.
69
70	### 4. Repeat Until Done
71
72	Continue processing batches until all files are documented.
73
74	### 5. Verify Coverage
75
76	```bash
77	composer docs:coverage
78	```
79
80	Confirm improvement toward targets (80% classes, 75% methods).
81
82	## Subagent Prompt Template
83
84	```
85	Write PHPDoc blocks for app/{PATH}
86
87	1. Read the file thoroughly to understand its purpose
88	2. Check what's already documented vs missing
89	3. Add comprehensive docblocks for:
90	- Class-level documentation explaining purpose and context
91	- All undocumented public methods with @param, @return, @throws
92	- Protected/private methods with brief explanations
93	4. Follow project-specific conventions and domain terminology
94	5. Run pint after editing: ./vendor/bin/pint {file}
95
96	Target audience: New developer on their first day.
97	```
98
99	## Common Mistakes
100
101	Dispatching sequentially: Each file one at a time wastes time. Use batches of 5 in parallel.
102
103	Not using single message: Multiple Task calls in separate messages run sequentially. Put all 5 in ONE message.
104
105	Skipping verification: Always run `composer docs:coverage` at the end to confirm improvement.
106
107	Forgetting pint: Subagents should run `./vendor/bin/pint` after editing to maintain code style.

People who liked this also viewed

6 picks

Type

grill-with-docsA relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.SkillsJul 2026537k182k
lark-minutes飞书妙记：搜索妙记、查看妙记基础信息、下载/上传音视频、读取或编辑妙记的产物内容、改标题、替换说话人/关键词、申请妙记查看/编辑权限。当给出minute_token、本地音视频文件，要查/改/转妙记产物，或用户明确要主动申请妙记权限时使用；本地音视频转纪要/逐字稿优先走本 skill，不要用 ffmpeg/whisper 本地转写。不负责：获取会议关联妙记，或仅按自然语言标题定位纪要SkillsJul 2026379k16k
lark-markdown飞书 Markdown：查看、创建、上传、编辑和比较 Markdown 文件。当用户需要创建或编辑 Markdown 文件、读取、修改、局部 patch 或比较差异时使用。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。SkillsJul 2026295k16k
docxUse this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', SkillsJul 2026157k163k
edit-articleSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026154k181k
lark-note飞书会议纪要（Note）直查：已知 note_id 时查询纪要详情、展示类型、关联文档 token，并读取 unified 原始逐字记录。当用户已持有 note_id，或从文档显式 vc-node-id 获得 note_id 时使用。不负责会议/日程/妙记定位、文档标题搜索或 Docx 正文读取。SkillsJul 2026154k16k

write-docblocks

120stars16forks

View on GitHub

How to install write-docblocks?

aaddrick/claude-pipeline/write-docblocks

$npx -y skills add aaddrick/claude-pipeline --skill write-docblocks

Installs into the current project.

Summary

Use when documentation coverage is low, after composer docs:coverage shows gaps, or when asked to batch-write PHPDoc blocks across multiple files

Files · 1

View on GitHub

SKILL.md

1	# Write Docblocks
2
3	## Overview
4
5	Batch-process PHPDoc documentation gaps by running `composer docs:coverage:missing` and dispatching parallel phpdoc-writer subagents.
6
7	Core principle: Process files in batches of 5 subagents for efficient parallel documentation without overwhelming the system.
8
9	## When to Use
10
11	- Documentation coverage below target (80% classes, 75% methods)
12	- After creating multiple new services, controllers, or models
13	- When `composer docs:coverage:missing` shows many files needing docs
14	- User requests batch PHPDoc writing
15
16	## Workflow
17
18	```dot
19	digraph write_docblocks {
20	rankdir=TB;
21
22	start [label="Run composer docs:coverage:missing" shape=box];
23	parse [label="Parse output for file paths" shape=box];
24	check [label="Files remaining?" shape=diamond];
25	batch [label="Take next 5 files" shape=box];
26	dispatch [label="Dispatch 5 phpdoc-writer\nsubagents in parallel" shape=box];
27	wait [label="Wait for batch to complete" shape=box];
28	done [label="Run composer docs:coverage\nto verify improvement" shape=box];
29
30	start -> parse -> check;
31	check -> batch [label="yes"];
32	check -> done [label="no"];
33	batch -> dispatch -> wait -> check;
34	}
35	```
36
37	## Execution Steps
38
39	### 1. Get Missing Files
40
41	```bash
42	composer docs:coverage:missing 2>&1 \| sed 's/\x1b\[[0-9;]*m//g' \| grep '\.php$'
43	```
44
45	This strips ANSI codes and extracts just file paths like:
46	```
47	Console/Commands/ProcessDataCommand.php
48	Http/Controllers/AuthController.php
49	Services/AuthService.php
50	```
51
52	### 2. Process in Batches of 5
53
54	For each batch of 5 files, dispatch phpdoc-writer subagents in parallel using a single message with multiple Task tool calls:
55
56	```
57	Task(subagent_type="phpdoc-writer", prompt="Write PHPDoc blocks for app/Console/Commands/ProcessDataCommand.php - read the file, understand its purpose, and add comprehensive docblocks for the class and all undocumented methods.")
58
59	Task(subagent_type="phpdoc-writer", prompt="Write PHPDoc blocks for app/Http/Controllers/OAuthController.php - read the file, understand its purpose, and add comprehensive docblocks for the class and all undocumented methods.")
60
61	// ... 3 more in same message
62	```
63
64	CRITICAL: All 5 Task calls MUST be in a single assistant message to run in parallel.
65
66	### 3. Wait for Batch Completion
67
68	Wait for all 5 subagents to complete before starting the next batch. This prevents resource exhaustion while maintaining parallelism.
69
70	### 4. Repeat Until Done
71
72	Continue processing batches until all files are documented.
73
74	### 5. Verify Coverage
75
76	```bash
77	composer docs:coverage
78	```
79
80	Confirm improvement toward targets (80% classes, 75% methods).
81
82	## Subagent Prompt Template
83
84	```
85	Write PHPDoc blocks for app/{PATH}
86
87	1. Read the file thoroughly to understand its purpose
88	2. Check what's already documented vs missing
89	3. Add comprehensive docblocks for:
90	- Class-level documentation explaining purpose and context
91	- All undocumented public methods with @param, @return, @throws
92	- Protected/private methods with brief explanations
93	4. Follow project-specific conventions and domain terminology
94	5. Run pint after editing: ./vendor/bin/pint {file}
95
96	Target audience: New developer on their first day.
97	```
98
99	## Common Mistakes
100
101	Dispatching sequentially: Each file one at a time wastes time. Use batches of 5 in parallel.
102
103	Not using single message: Multiple Task calls in separate messages run sequentially. Put all 5 in ONE message.
104
105	Skipping verification: Always run `composer docs:coverage` at the end to confirm improvement.
106
107	Forgetting pint: Subagents should run `./vendor/bin/pint` after editing to maintain code style.

People who liked this also viewed

6 picks

Type