Skip to content

Commit 9242e1f

Browse files
committed
Step: Align README, Style Guide, Docs, and historical entries with writer/reviewer naming
1 parent d7752cc commit 9242e1f

11 files changed

Lines changed: 25 additions & 24 deletions

File tree

.gemini/style-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Gemini CLI Style Guide
22

3-
This guide defines the authoritative technical and narrative style for all project documentation, articles, and reports. The `/review` command and the `reviewer` subagent use these rules to perform structured, multi-phase, non-destructive audits.
3+
This guide defines the authoritative technical and narrative style for all project documentation, articles, and reports. The `/draft` command and its `writer` subagent use these rules for original composition, while the `/review` command and the `reviewer` subagent use them to perform structured, multi-phase, non-destructive audits.
44

55
## General Context
66
- **Tone:** Intellectual but accessible. Conversational academic style.

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,13 +144,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
144144

145145
### Added
146146
- Implemented `/plan` command workflow and `planner` subagent for architectural planning.
147-
- Added `/draft` and `/revise` commands with `reporter` and `editor` subagents for structured content generation.
147+
- Added `/draft` and `/review` commands with `writer` and `reviewer` subagents for structured content generation.
148148
- Created an actionable project style guide in `.gemini/style-guide.md`.
149149
- Drafted the "The Architect in the Machine" Substack article showcasing the framework.
150150

151151
### Changed
152152
- Overhauled the `/research` command into an extensible, executive-style reporting workflow with iterative updates and asset linking.
153-
- Refactored `/draft` and `/revise` commands to integrate step-by-step, style-driven audits.
153+
- Refactored `/draft` and `/review` commands to integrate step-by-step, style-driven audits.
154154
- Refined `/plan` and `/task` workflows.
155155

156156
## [0.7.0] - 2026-03-02
@@ -198,7 +198,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
198198
## [0.3.0] - 2026-02-28
199199

200200
### Added
201-
- Refactored the `/research` command into a robust 3-phase workflow using specialized `researcher` and `reporter` subagents.
201+
- Refactored the `/research` command into a robust 3-phase workflow using specialized `researcher` and `writer` subagents.
202202
- Rewrote the `README.md` to explain the opinionated framework, the agent's behavior, hooks, commands, journaling, and the project initialization workflow.
203203

204204
### Changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ The `.gemini/commands/` directory defines specialized workflows that automate ev
7373
* **`/scaffold`**: Initializes new project structures from scratch using modern, standard tooling (Python/uv, TS/npm, Rust/cargo, etc.) and sets up a compatible `makefile`.
7474

7575
### 🧹 Phase 3: Content Generation, Maintenance & Documentation
76-
* **`/draft`**: Multi-phase workflow to turn research and plans into detailed, high-quality technical documents or articles section-by-section.
76+
* **`/draft`**: Multi-phase workflow to turn research and plans into detailed, high-quality technical documents or articles section-by-section using the `writer` subagent.
7777
* **`/review`**: Uses the `reviewer` subagent to perform non-destructive, multi-phase structural and linguistic audits based on the project's style guide.
7878
* **`/maintenance`**: Performs a deep scan of the codebase to identify technical debt, refactoring opportunities, and areas to improve test coverage.
7979
* **`/document`**: Analyzes the codebase and journals to generate or update comprehensive project documentation in the `docs/` folder.

TASKS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Put done tasks into the Archive.
5555
- [x] Add the /issues command to manage project issues with GitHub CLI. (2026-02-28)
5656
- [x] Refactor the hook system: centralize shared logic into `.gemini/hooks/utils.py` and add PEP 257 docstrings. (2026-02-28)
5757
- [x] Rewrite the `README.md` to explain the opinionated framework and its key features. (2026-02-28)
58-
- [x] Refactor the `/research` command into a 3-phase workflow with researcher and reporter subagents. (2026-02-28)
58+
- [x] Refactor the `/research` command into a 3-phase workflow with researcher and writer subagents. (2026-02-28)
5959
- [x] Consolidate the `/task/*` commands into a single `/task` command. (2026-02-28)
6060

6161
> Done tasks go here, in the order they where finished, with a finished date.

docs/design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Instead of a single "do-it-all" AI, the framework delegates tasks to specialized
7979
- **`debugger`:** A forensic investigation specialist using a scientific, hypothesis-driven workflow.
8080
- **`learner`:** A "Grounded Learning Specialist" who masters new technologies by writing, executing, and documenting code experiments.
8181
- **`researcher`:** Optimized for deep information gathering and multi-source synthesis.
82-
- **`reporter` / `editor`:** Content generation and refinement specialists.
82+
- **`writer` / `reviewer`:** Content generation and refinement specialists.
8383

8484
### 5. The Skill System (`.gemini/skills/`)
8585

docs/user-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This framework solves this problem by enforcing three core principles:
1414

1515
1. **The important things should be made explicit:** We keep track of everything important in Markdown files. Ideas are committed to `plans/`, research is summarized in `research/`, and all changes are logged in the `journal/`. This physical "long-term memory" prevents the agent from forgetting context.
1616
2. **Resist the urge to guess:** We favor explicit commands over implicit actions. If you want the model to make a plan, you use the `/plan` command, which invokes a carefully crafted workflow rather than relying on the agent's default behavior.
17-
3. **Delegate, delegate, delegate:** We use specialized sub-agents (`planner`, `researcher`, `reporter`, `editor`). These agents run complex, multi-step tasks in private contexts, preventing their internal reasoning (e.g., browsing 20 web pages) from polluting the main session's context window.
17+
3. **Delegate, delegate, delegate:** We use specialized sub-agents (`planner`, `researcher`, `writer`, `reviewer`). These agents run complex, multi-step tasks in private contexts, preventing their internal reasoning (e.g., browsing 20 web pages) from polluting the main session's context window.
1818

1919
---
2020

@@ -168,7 +168,7 @@ Beyond code, this framework excels at generating high-quality technical content
168168

169169
Your primary tool for long-form technical writing.
170170

171-
- **How it works:** Instead of generating a single large blob of text, the `/draft` command follows a strict 6-phase workflow: Context Gathering (from `research/` or `plans/`), Title & Metadata Selection, Outline Creation (aligned with the Style Guide), Initialization of the file, Section-by-Section Drafting (using the `reporter` subagent), and finally, a Conclusion with next steps.
171+
- **How it works:** Instead of generating a single large blob of text, the `/draft` command follows a strict 6-phase workflow: Context Gathering (from `research/` or `plans/`), Title & Metadata Selection, Outline Creation (aligned with the Style Guide), Initialization of the file, Section-by-Section Drafting (using the `writer` subagent), and finally, a Conclusion with next steps.
172172
- **Why it works:** It forces structural integrity and prevents the "AI-ish" monotone by building the document incrementally based on project-specific research.
173173

174174
### `/review`

drafts/architect-in-the-machine.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ I use four sub-agents in different commands. The `planner` is the lead architect
4444

4545
When I need external knowledge---like a library’s latest API or a specific technical specification---the `researcher` agent takes over. It scours the web to fetch relevant documentation, which it then synthesizes into granular summaries in the `research/` directory. This raw data is then handed off to the main agent to build an executive report annotated and linked to all relevant sources, again all stored already in your repository.
4646

47-
And there are two more agents, specifically designed for technical writing. The `reporter` agent takes an outline, and a folder of content, and it will write section by section, a detailed account of what the outline requested.
47+
And there are two more agents, specifically designed for technical writing. The `writer` agent takes an outline, and a folder of content, and it will write section by section, a detailed account of what the outline requested.
4848

49-
Unlike a standard LLM that might provide a high-level summary, the `reporter` is trained to expand specific placeholders with deep, evidence-based paragraphs. It draws directly from your `research/` files and the project `journal/` to ensure every sentence is grounded in the project's actual state. Finally, the `editor` provides the final polish, auditing the draft for structural gaps and linguistic tics. It is grounded in a customizable style guide to make sure it always respects your style.
49+
Unlike a standard LLM that might provide a high-level summary, the `writer` is trained to expand specific placeholders with deep, evidence-based paragraphs. It draws directly from your `research/` files and the project `journal/` to ensure every sentence is grounded in the project's actual state. Finally, the `reviewer` provides the final polish, auditing the draft for structural gaps and linguistic tics. It is grounded in a customizable style guide to make sure it always respects your style.
5050

5151
This distributed intelligence is held together by a central nervous system of context files, as per principle one. A `journal/` directory provides a chronological record of decisions and progress, acting as a long-term memory for the project. The `plans/` directory stores the strategic intent, while a `TASKS.md` file provides a high-level overview of the project's current status. This structured environment allows the subagents to maintain a high degree of situational awareness without needing to ingest the entire repository in every turn.
5252

@@ -88,17 +88,17 @@ Anyway, the approach is built on the same cognitive foundation as the developmen
8888

8989
It starts with the `/draft` command. In its initial phase, the system performs a deep scan of the `research/` and `plans/` directories to identify the key themes relevant to the requested topic. If the foundation is too thin, the system will pause and suggest a `/research` or `/plan` cycle to ensure the draft has sufficient substance. Once the context is validated, the workflow enters an interactive "Outline Creation" phase. Rather than guessing at a structure, the system proposes a detailed Markdown outline. This collaborative step allows me to set the narrative arc and logical flow that I want, iterating on the high-level structure of, say, a technical article, before committing on the details.
9090

91-
Once the outline is locked, the `/draft` process initializes a skeleton file---complete with section headers and strategic placeholders---and then moves into an iterative, section-by-section expansion. Here, the `reporter` subagent takes the lead. Guided by the specific context of each section, the `reporter` weaves together research summaries and technical specifications into professional prose, all grounded on a style guide document.
91+
Once the outline is locked, the `/draft` process initializes a skeleton file---complete with section headers and strategic placeholders---and then moves into an iterative, section-by-section expansion. Here, the `writer` subagent takes the lead. Guided by the specific context of each section, the `writer` weaves together research summaries and technical specifications into professional prose, all grounded on a style guide document.
9292

9393
Because the expansion happens in granular steps, the system maintains a high level of detail that a single-shot generation would inevitably lose. The result is a first draft that is structurally sound and rich with technical depth.
9494

95-
However, a first draft is rarely the final word. It will always sound AI-ish, and for many other reasons, it is rarely good enough. To achieve professional quality, I use the `/revise` command, which runs a structural and linguistic audit powered by the `editor` subagent following the same style guide.
95+
However, a first draft is rarely the final word. It will always sound AI-ish, and for many other reasons, it is rarely good enough. To achieve professional quality, I use the `/review` command, which runs a non-destructive, multi-phase audit powered by the `reviewer` subagent following the same style guide. This process produces a dedicated review report, identifying structural gaps and linguistic tics, which I then apply back to the draft using the `/draft` command's refinement mode.
9696

97-
Unlike a simple "check my writing" prompt, the `editor` performs a deep analysis of the document's flow and tone. It identifies logical gaps where more evidence might be needed and highlights awkward phrasing that could obscure my intent. And crucially, this isn't an automated "fix-all" tool; it's an interactive process. The system presents its findings and proposes specific improvements, which I can then review or approve.
97+
Unlike a simple "check my writing" prompt, the `reviewer` performs a deep analysis of the document's flow and tone. It identifies logical gaps where more evidence might be needed and highlights awkward phrasing that could obscure my intent. And crucially, this isn't an automated "fix-all" tool; it's an interactive process. The system presents its findings and proposes specific improvements, which I can then review or approve.
9898

99-
This collaborative refinement process ensures the final output maintains a consistent, professional voice while benefiting from the speed of the AI. By using `/revise`, I can surgically improve the text to enhance clarity and impact without losing control over the narrative.
99+
This collaborative refinement process ensures the final output maintains a consistent, professional voice while benefiting from the speed of the AI. By using `/review` and `/draft` refinement, I can surgically improve the text to enhance clarity and impact without losing control over the narrative.
100100

101-
But, in any case, I always find necessary a manual review and editing after all the AI enhancements. It shouldn't be a surprise to you that this article is written in this way, but what you're reading now is probably 80% different to what the final `/revise` iteration gave me. There is only so much you can prompt an AI, and that final human touch is not part of it.
101+
But, in any case, I always find necessary a manual review and editing after all the AI enhancements. It shouldn't be a surprise to you that this article is written in this way, but what you're reading now is probably 80% different to what the final `/review` iteration gave me. There is only so much you can prompt an AI, and that final human touch is not part of it.
102102

103103
But that's good. This automates the first 80% or so of compiling a gazillion sources into a coherent narrative, and leaves the remaining 80% of polishing for me, which is the part I actually enjoy about writing.
104104

journal/2026-02-28.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
- Consolidated `/task/*` commands (`create`, `work`, `report`, `update`) into a single `/task` command in `.gemini/commands/task.toml`.
22
- Added a new `/scaffold` command to initialize new projects with modern standard practices and tooling.
3-
- Refactored the `/research` command into a robust 3-phase workflow using specialized `researcher` and `reporter` subagents.
3+
- Refactored the `/research` command into a robust 3-phase workflow using specialized `researcher` and `writer` subagents.
44
- Rewrote the `README.md` to explain the opinionated framework, the agent's behavior, hooks, commands, journaling, and the project initialization workflow.
55
- Refactored the hook system: centralized shared logic into `.gemini/hooks/utils.py` and added PEP 257 docstrings to all hooks.
66
- Released version 0.4.0, documenting the hook system refactor and internal improvements.

journal/2026-03-02.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
- Beautified `README.md` with project badges, emoji headers, and improved formatting.
44
- Restored and updated `CHANGELOG.md` for the v0.7.0 release.
55
- Implemented a custom `/plan` command workflow and a `planner` sub-agent to generate execution plans in `plans/` and synchronize with `TASKS.md`.
6-
- Initiated the planning process for drafting and editing capabilities, including the design of `/draft` and `/revise` commands and subagent integration.
6+
- Initiated the planning process for drafting and editing capabilities, including the design of `/draft` and `/review` commands and subagent integration.
77
- Reorganized `README.md` to reflect a structured project lifecycle (Planning, Development, Maintenance, Shipping) and documented the `/plan` command's interactive phases.
8-
- Implemented `/draft` and `/revise` commands, refactored the `reporter` agent, and created the `editor` subagent to enable structured drafting and editing workflows.
9-
- Drafted a comprehensive Substack article "The Architect in the Machine" using the new `/draft` command and `reporter` subagent, showcasing the repository's AI-assisted development workflow.
10-
- Created an actionable project style guide in `.gemini/style-guide.md` and refactored `/draft` and `/revise` commands to integrate step-by-step, style-driven audits.
8+
- Implemented `/draft` and `/review` commands, refactored the `writer` agent, and created the `reviewer` subagent to enable structured drafting and editing workflows.
9+
- Drafted a comprehensive Substack article "The Architect in the Machine" using the new `/draft` command and `writer` subagent, showcasing the repository's AI-assisted development workflow.
10+
- Created an actionable project style guide in `.gemini/style-guide.md` and refactored `/draft` and `/review` commands to integrate step-by-step, style-driven audits.
1111
- Refactored the `/research` command into an extensible, executive-style reporting workflow with iterative report updates, detailed asset linking, and conclusion/recommendation synthesis.
1212
- Released v0.8.0 with planning, drafting, and editing capabilities, refactored research workflow, and updated README/CHANGELOG.
1313
- Refined the Substack draft "The Architect in the Machine" by fixing typos, spelling, and grammar errors while preserving the original style.

journal/2026-03-23.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@
88
[2026-03-23T06:00:12] - Plan and task for improving /draft command and evolve writer agent.
99
[2026-03-23T06:00:52] - Rename reporter agent to writer and update its definition for composition and refinement.
1010
[2026-03-23T06:01:22] - Update /draft command with branching logic for initial drafting and review-driven refinement.
11+
[2026-03-23T06:07:18] - Align README, Style Guide, Docs, and historical entries with writer/reviewer naming.

0 commit comments

Comments
 (0)