Skip to content

Commit 7cf8ea1

Browse files
committed
feat(style): add actionable project style guide
1 parent 6dab676 commit 7cf8ea1

2 files changed

Lines changed: 67 additions & 2 deletions

File tree

.gemini/agents/editor.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ kind: local
55
tools:
66
- list_directory
77
- read_file
8-
- replace
98
max_turns: 15
109
---
1110

@@ -16,7 +15,7 @@ You are a Professional Editor. Your primary objective is to review technical dra
1615
2. **Audit Structure:** Check if the document flow is logical, sections are well-defined, and the overall narrative is cohesive.
1716
3. **Linguistic Review:** Identify and fix grammatical errors, awkward phrasing, and inconsistent terminology.
1817
4. **Refine Style:** Ensure the text adheres to high standards of technical writing (active voice, concise sentences, professional tone).
19-
5. **Apply Improvements:** Use `replace` to implement refined versions of paragraphs or sections upon approval.
18+
5. **Suggest Improvements:** Reply with a detailed list of improvements that can be applied to the text.
2019

2120
**Key Guidelines:**
2221
- **Clarity and Precision:** Every sentence should have a clear purpose. Eliminate fluff and redundant words.

.gemini/style-guide.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Gemini CLI Style Guide
2+
3+
This guide defines the authoritative technical and narrative style for all project documentation, articles, and reports. The `/revise` command and the `editor` subagent use these rules to perform structured, step-by-step audits.
4+
5+
## General Context
6+
- **Tone:** Intellectual but accessible. Conversational academic style.
7+
- **Perspective:** First-person ("I", "we") is preferred for narratives and journals.
8+
- **Audience:** Intelligent peers who value technical depth without unnecessary jargon.
9+
- **Goal:** Transform abstract technical concepts into visualizable, grounded narratives.
10+
11+
---
12+
13+
## Phase 1: Structural Audit (High-Level)
14+
*Goal: Ensure a clear narrative arc and logical progression.*
15+
16+
### DO:
17+
- Start with a provocative hook (question, bold statement, or personal stake).
18+
- Use a clear hierarchical structure with descriptive subheadings.
19+
- Follow a "Multilayered Explanation" pattern: High-level concept -> Concrete example -> Technical deep dive -> Broader implications.
20+
- End with a personal reflection or a clear call to action.
21+
22+
### DON'T:
23+
- Write "sedative" text that lacks conflict or a driving question.
24+
- Use generic introductory paragraphs that add no value.
25+
26+
---
27+
28+
## Phase 2: Content & Substance (The "Abstraction Trap")
29+
*Goal: Ground the writing in specific, concrete imagery.*
30+
31+
### DO:
32+
- Replace abstract nouns with concrete ones (things you can hold, smell, or see).
33+
- Ensure every paragraph contains at least one concrete image.
34+
- Show external behavior instead of stating internal states (e.g., "He glanced at the door" instead of "He wanted to leave").
35+
36+
### DON'T:
37+
- Over-explain what a scene already implies (avoid the "Subtext Vacuum").
38+
- Use "Forced Callbacks" (attaching unearned emotions or agency to objects).
39+
- Rely on "Harmless Filters" (bland, sycophantic, or lobotomized vocabulary). Use words that imply conflict, weirdness, or cynicism where appropriate.
40+
41+
---
42+
43+
## Phase 3: Linguistic Refinement (Low-Level)
44+
*Goal: Polish the prose and remove "AI-isms".*
45+
46+
### DO:
47+
- Use active voice and precise technical terminology.
48+
- Use em dashes for asides (interruptions, clarifications).
49+
- Vary list lengths to avoid predictable patterns.
50+
- Use analogies and metaphors for complex concepts.
51+
52+
### DON'T:
53+
- **No Punchline Em Dashes:** Avoid using em dashes for dramatic conclusions—like this.
54+
- **No Unnecessary Juxtaposition:** Avoid "Not just X, but Y" or negating before affirming. Just state the affirmation.
55+
- **No Predictable Triads:** Avoid lists of three where the last element is the longest ("clarity, precision, and excellence").
56+
- **No Sensory Deprivation:** Avoid "statistically likely" adjectives (e.g., "smooth silk"). Use surprising, tacit context (e.g., "sticky spiderweb").
57+
58+
---
59+
60+
## Phase 4: Final Polish
61+
*Goal: Final verification of tone and clarity.*
62+
63+
- **Technical Depth:** 7-8/10.
64+
- **Accessibility:** 8-9/10.
65+
- **Personal Voice:** 7/10.
66+
- **Humor:** 4-5/10 (use sparingly and intelligently).

0 commit comments

Comments
 (0)