技能 写作 规划
- 作者仓库星标 3,406
- 作者仓库 claude-octopus
Host: Codex CLI — This skill was designed for Claude Code and adapted for Codex. Cross-reference commands use installed skill names in Codex rather than
/octo:*slash commands. Use the active Codex shell and subagent tools. Do not claim a provider, model, or host subagent is available until the current session exposes it. For host tool equivalents, seeskills/blocks/codex-host-adapter.md.
Writing Plans
MANDATORY COMPLIANCE — DO NOT SKIP
When this skill is invoked, you MUST produce a full implementation plan following the structure below. You are PROHIBITED from:
- Skipping the plan and jumping straight to implementation
- Producing a vague outline instead of the zero-context plan format
- Deciding the task is "simple enough" to not need a plan
- Omitting file paths, complete code, test instructions, or verification steps
The user asked for a plan, not an implementation. Write the plan first.
Your first output line MUST be: 🐙 **CLAUDE OCTOPUS ACTIVATED** - Implementation Planning
Overview
Write comprehensive implementation plans assuming the engineer has zero context for the codebase and questionable taste.
Document everything: which files to touch, complete code, how to test, how to verify.
Principles: DRY. YAGNI. TDD. Frequent commits.
Plan Document Structure
Header (Required)
# [Feature Name] Implementation Plan
**Goal:** [One sentence describing what this builds]
**Architecture:** [2-3 sentences about approach]
**Tech Stack:** [Key technologies/libraries]
**Estimated Time:** [X tasks × 5 min = Y minutes]
## Prerequisites
- [ ] [Any setup needed before starting]
- [ ] [Dependencies to install]
- [ ] [Files that must exist]
Task Granularity
Each task is ONE action (2-5 minutes):
| Good (Single Action) | Bad (Multiple Actions) |
|---|---|
| "Write the failing test" | "Write tests and implement" |
| "Run test to verify it fails" | "Make it work" |
| "Implement minimal code to pass" | "Add the feature" |
| "Commit with message" | "Finish the feature" |
Task Template
### Task N: [Component Name]
**Files:**
- Create: `exact/path/to/new-file.ts`
- Modify: `exact/path/to/existing.ts` (lines 45-67)
- Test: `tests/exact/path/to/test.spec.ts`
**Step 1: Write failing test**
```typescript
// tests/exact/path/to/test.spec.ts
describe('ComponentName', () => {
it('should do specific thing', () => {
const result = functionName(input);
expect(result).toBe(expected);
});
});
Step 2: Run test to verify it fails
npm test tests/exact/path/to/test.spec.ts
Expected output:
FAIL: expected 'expected' but got undefined
Step 3: Implement minimal code
// exact/path/to/new-file.ts
export function functionName(input: InputType): OutputType {
// Minimal implementation
return expected;
}
Step 4: Run test to verify it passes
npm test tests/exact/path/to/test.spec.ts
Expected output:
PASS: 1/1 tests passed
Step 5: Commit
git add tests/exact/path/to/test.spec.ts exact/path/to/new-file.ts
git commit -m "feat(component): add specific functionality"
## Example: Complete Task
```markdown
### Task 3: Add Email Validation
**Files:**
- Create: `src/validators/email.ts`
- Test: `tests/validators/email.spec.ts`
**Step 1: Write failing test**
```typescript
// tests/validators/email.spec.ts
import { validateEmail } from '../src/validators/email';
describe('validateEmail', () => {
it('returns error for empty email', () => {
const result = validateEmail('');
expect(result).toEqual({ valid: false, error: 'Email required' });
});
it('returns error for invalid format', () => {
const result = validateEmail('not-an-email');
expect(result).toEqual({ valid: false, error: 'Invalid email format' });
});
it('returns valid for correct email', () => {
const result = validateEmail('user@example.com');
expect(result).toEqual({ valid: true });
});
});
Step 2: Run test to verify it fails
npm test tests/validators/email.spec.ts
Expected: Cannot find module '../src/validators/email'
Step 3: Implement minimal code
// src/validators/email.ts
interface ValidationResult {
valid: boolean;
error?: string;
}
export function validateEmail(email: string): ValidationResult {
if (!email || !email.trim()) {
return { valid: false, error: 'Email required' };
}
const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
if (!emailRegex.test(email)) {
return { valid: false, error: 'Invalid email format' };
}
return { valid: true };
}
Step 4: Run test to verify it passes
npm test tests/validators/email.spec.ts
Expected: PASS: 3/3 tests passed
Step 5: Commit
git add src/validators/email.ts tests/validators/email.spec.ts
git commit -m "feat(validators): add email validation with tests"
## Integration with Claude Octopus
### Using Octopus for Plan Execution
After creating a plan, offer execution options:
```markdown
## Execution Options
**1. Sequential (this session)**
Execute tasks one by one with verification between each.
**2. Parallel (octopus tangle)**
Use Claude Octopus to parallelize independent tasks:
```bash
${HOME}/.claude-octopus/plugin/scripts/orchestrate.sh tangle "Execute implementation plan for [feature]"
3. Full workflow (octopus embrace) Research → Define → Implement → Deliver:
${HOME}/.claude-octopus/plugin/scripts/orchestrate.sh embrace "Implement [feature] per plan"
### Plan Storage (Claude Code v2.1.10)
Claude Octopus uses session-aware plan storage. Plans are automatically saved to:
~/.claude-octopus/plans/${CLAUDE_SESSION_ID}/YYYY-MM-DD-feature-name.md
This integrates with Claude Code's `plansDirectory` setting. To customize:
```json
// settings.json
{
"plansDirectory": "~/.claude-octopus/plans"
}
For project-local plans, save to docs/plans/:
mkdir -p docs/plans
# docs/plans/2026-01-17-user-authentication.md
Checklist for Good Plans
- Each task is 2-5 minutes (single action)
- Exact file paths (not "in the utils folder")
- Complete code (not "add validation logic")
- Exact commands with expected output
- TDD: test before implementation
- Commit after each task
Common Mistakes
| Mistake | Fix |
|---|---|
| "Add the validation" | Show exact code |
| "Update the tests" | Show exact test code |
| "In the config file" | config/app.config.ts line 23 |
| "Run the tests" | npm test path/to/specific.spec.ts |
| Large tasks (30+ min) | Break into 2-5 min steps |
| No verification | Add "Run X, expect Y" |
When to Create Plans
| Scenario | Use Plan? |
|---|---|
| Multi-step feature (3+ tasks) | Yes |
| Simple bug fix (1 task) | No, just do it |
| Uncertain scope | Yes (clarifies thinking) |
| Delegation to subagent | Yes (zero-context execution) |
| Complex refactoring | Yes |
| Config change | No |
Related Skills
- test-driven-development - Each task follows TDD cycle
- verification-before-completion - Verify each step
- finishing-branch - After all tasks complete
The Bottom Line
Plan exists → Engineer with zero context can execute
Otherwise → Not a complete plan
Exact paths. Complete code. Verification steps. No assumptions.
- 流狐分类
- 写作
- 作者声明 Agent
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 88 / 100 · 启发式扫描,不代表运行安全
- 作者 / 版本 / 许可
- @nyldn · 未声明 license
- 流狐 Token 估算
- 低消耗
- 流狐接入估算
- 需简单配置
- 是否需要外部 API Key
- 未发现要求
- 检测到的系统要求
- macOS · Linux · Windows
- 底层运行要求
- 未声明
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- Shell 执行
- 检测到的网络行为
- 仅限本地
- 安装命令数
- 无(仅作为资料)
档案由构建时根据 SKILL.md 与安装命令自动衍生,可能与作者实际意图存在差异。
需要注意: 未限定 allowed-tools,默认拥有全部工具权限。
作者没有在当前 SKILL.md 中定义固定输出样例。 When this skill is invoked, you MUST produce a full implementation plan following the structure below. You are PROHIBITED from: Skipping the plan and jumping straight to implementation Producing a vague outline instead of the zero-context plan format
Write comprehensive implementation plans assuming the engineer has zero context for the codebase and questionable taste. Document everything: which files to touch, complete code, how to test, how to verify. Principles: DRY. YAGNI. TDD. Frequent commits.
Plan Document Structure
Header (Required)
[ ] [Any setup needed before starting] [ ] [Dependencies to install] [ ] [Files that must exist]
Each task is ONE action (2-5 minutes): Good (Single Action) · Bad (Multiple Actions) "Write the failing test" · "Write tests and implement"
> **Host: Codex CLI** — This skill was designed for Claude Code and adapted for Codex.
> Cross-reference commands use installed skill names in Codex rather than `/octo:*` slash commands.
> Use the active Codex shell and subagent tools. Do not claim a provider, model, or host subagent is available until the current session exposes it.
> For host tool equivalents, see `skills/blocks/codex-host-adapter.md`.
# Writing Plans
## MANDATORY COMPLIANCE — DO NOT SKIP
**When this skill is invoked, you MUST produce a full implementation plan following the structure below. You are PROHIBITED from:**
- Skipping the plan and jumping straight to implementation
- Producing a vague outline instead of the zero-context plan format
- Deciding the task is "simple enough" to not need a plan
- Omitting file paths, complete code, test instructions, or verification steps
**The user asked for a plan, not an implementation. Write the plan first.**
**Your first output line MUST be:** `🐙 **CLAUDE OCTOPUS ACTIVATED** - Implementation Planning`
## Overview
Write comprehensive implementation plans assuming the engineer has **zero context** for the codebase and **questionable taste**.
Document everything: which files to touch, complete code, how to test, how to verify.
**Principles:** DRY. YAGNI. TDD. Frequent commits.
## Plan Document Structure
### Header (Required)
```markdown
# [Feature Name] Implementation Plan
**Goal:** [One sentence describing what this builds]
**Architecture:** [2-3 sentences about approach]
**Tech Stack:** [Key technologies/libraries]
**Estimated Time:** [X tasks × 5 min = Y minutes]
## Prerequisites
- [ ] [Any setup needed before starting]
- [ ] [Dependencies to install]
- [ ] [Files that must exist]
```
## Task Granularity
… 作者原文负责流程事实;流狐只索引当前章节、要点、文件与命令。
章节 -> MANDATORY COMPLIANCE — DO NOT SKIP → Overview → Plan Document Structure → Header (Required) → Prerequisites → Task Granularity
要点 -> Host: Codex CLI · The user asked for a plan, not an implementation. Write the plan first. · Your first output line MUST be · CLAUDE OCTOPUS ACTIVATED · zero context · questionable taste · Principles · Goal
文件/命令 -> /octo: · skills/blocks/codex-host-adapter.md · 🐙 CLAUDE OCTOPUS ACTIVATED - Implementation Planning · exact/path/to/new-file.ts · exact/path/to/existing.ts · tests/exact/path/to/test.spec.ts · src/validators/email.ts · tests/validators/email.spec.ts
内容 SHA-256 -> 3cca67be8444
原文结构
适用与边界
原文中的明确线索
/octo:、skills/blocks/codex-host-adapter.md、🐙 CLAUDE OCTOPUS ACTIVATED - Implementation Planning、exact/path/to/new-file.ts、exact/path/to/existing.ts、tests/exact/path/to/test.spec.ts、src/validators/email.ts、tests/validators/email.spec.ts