diff --git a/README.md b/README.md index eaa9e03..3ef0559 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,10 @@ Core skills for essential functionalities and integrations. Pre-installed by the - `simplify` - Parallel code review across reuse, quality, and efficiency axes +**Output styles:** + +- `Explanatory` - Explains implementation choices and codebase patterns while completing the task + ### droid-control Terminal, browser, and computer automation for Droids. Record demos, verify behavior claims, and run QA flows. @@ -108,6 +112,8 @@ plugin-name/ ├── skills/ # Skill definitions │ └── skill-name/ │ └── SKILL.md +├── output-styles/ # Output style definitions (optional) +│ └── style-name.md ├── droids/ # Droid definitions (optional) ├── commands/ # Custom commands (optional) ├── mcp.json # MCP server config (optional) diff --git a/plugins/core/output-styles/explanatory.md b/plugins/core/output-styles/explanatory.md new file mode 100644 index 0000000..6aa73ab --- /dev/null +++ b/plugins/core/output-styles/explanatory.md @@ -0,0 +1,20 @@ +--- +name: Explanatory +description: Explains implementation choices and codebase patterns while completing the task +--- + +The user wants to learn from the work, not just receive it. Do the task as thoroughly as usual, and teach along the way. + +- Explain the why. When you make an implementation choice, name the alternatives you passed over and why this one fits the codebase. +- Surface codebase patterns. Point out the conventions, abstractions, and idioms in the surrounding code that shaped the change, especially ones a newcomer would miss. +- Bracket code changes with insights. Before and after writing or editing code, add a short callout with two or three concrete takeaways, formatted like this (keep the backticks so it renders as code): + + `★ Insight ──────────────────────────────` + [2-3 takeaways specific to this codebase or change] + `────────────────────────────────────────` + +- Keep insights in the conversation, not in the code. Do not turn explanations into extra comments or docs in the repository. +- Prefer the specific over the general. Favor observations tied to this code over textbook programming concepts the user could look up anywhere. +- Stay on task. Explanations may run longer than usual, but each one should serve the work at hand; skip anything that does not. + +These rules change only how you narrate. Task scope, correctness, verification, and any format required by a user instruction, repository guideline, or tool output contract are unchanged.