scriveno 2.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +222 -0
- package/agents/continuity-checker.md +85 -0
- package/agents/drafter.md +248 -0
- package/agents/plan-checker.md +209 -0
- package/agents/researcher.md +114 -0
- package/agents/translator.md +204 -0
- package/agents/voice-checker.md +154 -0
- package/bin/install.js +1620 -0
- package/commands/scr/add-note.md +51 -0
- package/commands/scr/add-unit.md +101 -0
- package/commands/scr/art-direction.md +225 -0
- package/commands/scr/autopilot-publish.md +210 -0
- package/commands/scr/autopilot-translate.md +237 -0
- package/commands/scr/autopilot.md +200 -0
- package/commands/scr/back-matter.md +630 -0
- package/commands/scr/back-translate.md +197 -0
- package/commands/scr/beta-reader.md +97 -0
- package/commands/scr/blurb.md +149 -0
- package/commands/scr/book-proposal.md +210 -0
- package/commands/scr/build-ebook.md +448 -0
- package/commands/scr/build-poetry-submission.md +202 -0
- package/commands/scr/build-print.md +598 -0
- package/commands/scr/build-smashwords.md +171 -0
- package/commands/scr/build-world.md +158 -0
- package/commands/scr/cast-list.md +104 -0
- package/commands/scr/chapter-header.md +158 -0
- package/commands/scr/character-arc.md +108 -0
- package/commands/scr/character-ref.md +160 -0
- package/commands/scr/character-sheet.md +143 -0
- package/commands/scr/character-touch.md +157 -0
- package/commands/scr/character-voice-sample.md +111 -0
- package/commands/scr/check-notes.md +50 -0
- package/commands/scr/cleanup.md +159 -0
- package/commands/scr/compare.md +112 -0
- package/commands/scr/complete-draft.md +49 -0
- package/commands/scr/continuity-check.md +129 -0
- package/commands/scr/copy-edit.md +118 -0
- package/commands/scr/cover-art.md +382 -0
- package/commands/scr/cultural-adaptation.md +177 -0
- package/commands/scr/demo.md +93 -0
- package/commands/scr/dialogue-audit.md +143 -0
- package/commands/scr/discuss.md +118 -0
- package/commands/scr/discussion-questions.md +129 -0
- package/commands/scr/do.md +68 -0
- package/commands/scr/draft.md +97 -0
- package/commands/scr/editor-review.md +466 -0
- package/commands/scr/export.md +942 -0
- package/commands/scr/fast.md +65 -0
- package/commands/scr/front-matter.md +696 -0
- package/commands/scr/health.md +113 -0
- package/commands/scr/help.md +121 -0
- package/commands/scr/history.md +92 -0
- package/commands/scr/illustrate-scene.md +211 -0
- package/commands/scr/import.md +95 -0
- package/commands/scr/insert-unit.md +108 -0
- package/commands/scr/line-edit.md +146 -0
- package/commands/scr/manager.md +77 -0
- package/commands/scr/manuscript-stats.md +139 -0
- package/commands/scr/map-illustration.md +213 -0
- package/commands/scr/map-manuscript.md +134 -0
- package/commands/scr/merge-units.md +136 -0
- package/commands/scr/multi-publish.md +344 -0
- package/commands/scr/new-character.md +167 -0
- package/commands/scr/new-revision.md +50 -0
- package/commands/scr/new-work.md +148 -0
- package/commands/scr/next.md +125 -0
- package/commands/scr/originality-check.md +170 -0
- package/commands/scr/outline.md +131 -0
- package/commands/scr/pacing-analysis.md +170 -0
- package/commands/scr/panel-layout.md +225 -0
- package/commands/scr/pause-work.md +88 -0
- package/commands/scr/plan.md +112 -0
- package/commands/scr/plant-seed.md +57 -0
- package/commands/scr/plot-graph.md +199 -0
- package/commands/scr/polish.md +141 -0
- package/commands/scr/profile-writer.md +154 -0
- package/commands/scr/progress.md +51 -0
- package/commands/scr/publish.md +455 -0
- package/commands/scr/query-letter.md +183 -0
- package/commands/scr/quick-write.md +82 -0
- package/commands/scr/relationship-map.md +129 -0
- package/commands/scr/remove-unit.md +120 -0
- package/commands/scr/reorder-units.md +126 -0
- package/commands/scr/resume-work.md +97 -0
- package/commands/scr/sacred/annotation-layer.md +105 -0
- package/commands/scr/sacred/chronology.md +121 -0
- package/commands/scr/sacred/concordance.md +88 -0
- package/commands/scr/sacred/cross-reference.md +97 -0
- package/commands/scr/sacred/doctrinal-check.md +129 -0
- package/commands/scr/sacred/genealogy.md +107 -0
- package/commands/scr/sacred/source-tracking.md +101 -0
- package/commands/scr/sacred/verse-numbering.md +103 -0
- package/commands/scr/sacred-numbering-format.md +103 -0
- package/commands/scr/save.md +109 -0
- package/commands/scr/scan.md +291 -0
- package/commands/scr/sensitivity-review.md +169 -0
- package/commands/scr/series-bible.md +127 -0
- package/commands/scr/session-report.md +80 -0
- package/commands/scr/settings.md +58 -0
- package/commands/scr/split-unit.md +123 -0
- package/commands/scr/spread-layout.md +187 -0
- package/commands/scr/storyboard.md +262 -0
- package/commands/scr/subject-touch.md +168 -0
- package/commands/scr/submit.md +50 -0
- package/commands/scr/subplot-map.md +147 -0
- package/commands/scr/sync.md +116 -0
- package/commands/scr/synopsis.md +137 -0
- package/commands/scr/theme-tracker.md +128 -0
- package/commands/scr/thread.md +83 -0
- package/commands/scr/timeline.md +141 -0
- package/commands/scr/track.md +564 -0
- package/commands/scr/translate.md +260 -0
- package/commands/scr/translation-glossary.md +298 -0
- package/commands/scr/translation-memory.md +310 -0
- package/commands/scr/troubleshoot.md +59 -0
- package/commands/scr/undo.md +106 -0
- package/commands/scr/validate.md +133 -0
- package/commands/scr/versions.md +94 -0
- package/commands/scr/voice-check.md +133 -0
- package/commands/scr/voice-test.md +68 -0
- package/data/CONSTRAINTS.json +1606 -0
- package/data/demo/.manuscript/BRIEF.md +37 -0
- package/data/demo/.manuscript/CHARACTERS.md +90 -0
- package/data/demo/.manuscript/OUTLINE.md +46 -0
- package/data/demo/.manuscript/PLOT-GRAPH.md +75 -0
- package/data/demo/.manuscript/STATE.md +44 -0
- package/data/demo/.manuscript/STYLE-GUIDE.md +119 -0
- package/data/demo/.manuscript/THEMES.md +51 -0
- package/data/demo/.manuscript/WORK.md +51 -0
- package/data/demo/.manuscript/config.json +59 -0
- package/data/demo/.manuscript/drafts/body/1-the-letter-DRAFT.md +51 -0
- package/data/demo/.manuscript/drafts/body/2-the-workshop-DRAFT.md +51 -0
- package/data/demo/.manuscript/drafts/body/3-the-pier-DRAFT.md +45 -0
- package/data/demo/.manuscript/drafts/body/4-the-clock-DRAFT.md +59 -0
- package/data/demo/.manuscript/plans/5-the-reunion-PLAN.md +52 -0
- package/data/demo/.manuscript/reviews/2-the-workshop-REVIEW.md +61 -0
- package/data/export-templates/scriveno-academic.latex +184 -0
- package/data/export-templates/scriveno-acm.latex +67 -0
- package/data/export-templates/scriveno-apa7.latex +83 -0
- package/data/export-templates/scriveno-book.typst +175 -0
- package/data/export-templates/scriveno-chapbook.typst +121 -0
- package/data/export-templates/scriveno-elsevier.latex +76 -0
- package/data/export-templates/scriveno-epub.css +386 -0
- package/data/export-templates/scriveno-fixed-layout-epub.css +76 -0
- package/data/export-templates/scriveno-fixed-layout.opf +23 -0
- package/data/export-templates/scriveno-ieee.latex +77 -0
- package/data/export-templates/scriveno-lncs.latex +79 -0
- package/data/export-templates/scriveno-picturebook.typst +113 -0
- package/data/export-templates/scriveno-poetry-submission-styles.md +45 -0
- package/data/export-templates/scriveno-poetry-submission.docx +0 -0
- package/data/export-templates/scriveno-smashwords-styles.md +45 -0
- package/data/export-templates/scriveno-smashwords.docx +0 -0
- package/data/export-templates/scriveno-stageplay.typst +129 -0
- package/data/proof/creative-context/README.md +79 -0
- package/data/proof/voice-dna/GUIDED-SAMPLE.md +19 -0
- package/data/proof/voice-dna/README.md +45 -0
- package/data/proof/voice-dna/STYLE-GUIDE-EXCERPT.md +43 -0
- package/data/proof/voice-dna/UNGUIDED-SAMPLE.md +11 -0
- package/data/proof/watchmaker-flow/README.md +78 -0
- package/docs/architecture.md +425 -0
- package/docs/command-reference.md +2384 -0
- package/docs/configuration.md +228 -0
- package/docs/context-protocol.md +81 -0
- package/docs/contributing.md +430 -0
- package/docs/creative-context.md +158 -0
- package/docs/development.md +152 -0
- package/docs/drafter-quality.md +127 -0
- package/docs/getting-started.md +198 -0
- package/docs/history-protocol.md +96 -0
- package/docs/proof-artifacts.md +56 -0
- package/docs/publishing.md +296 -0
- package/docs/release-notes.md +457 -0
- package/docs/runtime-support.md +77 -0
- package/docs/sacred-texts.md +296 -0
- package/docs/shipped-assets.md +129 -0
- package/docs/testing.md +156 -0
- package/docs/translation.md +343 -0
- package/docs/voice-dna.md +297 -0
- package/docs/work-types.md +339 -0
- package/lib/architectural-profiles.js +134 -0
- package/package.json +54 -0
- package/templates/BRIEF.md +51 -0
- package/templates/CHARACTERS.md +64 -0
- package/templates/CONTEXT.md +56 -0
- package/templates/OUTLINE.md +36 -0
- package/templates/RECORD.md +68 -0
- package/templates/STATE.md +50 -0
- package/templates/STYLE-GUIDE.md +121 -0
- package/templates/THEMES.md +36 -0
- package/templates/WORK.md +67 -0
- package/templates/WORLD.md +62 -0
- package/templates/WRITING-RULES.md +156 -0
- package/templates/academic/ARGUMENT-MAP.md +40 -0
- package/templates/academic/CONCEPTS.md +34 -0
- package/templates/academic/CONTEXT.md +29 -0
- package/templates/academic/PROPOSAL.md +37 -0
- package/templates/academic/QUESTIONS.md +24 -0
- package/templates/config.json +72 -0
- package/templates/pitfalls/comic.md +54 -0
- package/templates/pitfalls/commentary.md +62 -0
- package/templates/pitfalls/memoir.md +48 -0
- package/templates/pitfalls/novel.md +53 -0
- package/templates/pitfalls/poetry_collection.md +63 -0
- package/templates/pitfalls/research_paper.md +66 -0
- package/templates/pitfalls/runbook.md +64 -0
- package/templates/pitfalls/screenplay.md +54 -0
- package/templates/platforms/README.md +16 -0
- package/templates/platforms/apple/manifest.yaml +20 -0
- package/templates/platforms/bn/manifest.yaml +20 -0
- package/templates/platforms/d2d/manifest.yaml +20 -0
- package/templates/platforms/google/manifest.yaml +20 -0
- package/templates/platforms/ingram/manifest.yaml +44 -0
- package/templates/platforms/kdp/manifest.yaml +42 -0
- package/templates/platforms/kobo/manifest.yaml +20 -0
- package/templates/platforms/smashwords/manifest.yaml +26 -0
- package/templates/sacred/COSMOLOGY.md +88 -0
- package/templates/sacred/DOCTRINES.md +45 -0
- package/templates/sacred/FIGURES.md +69 -0
- package/templates/sacred/FRAMEWORK.md +98 -0
- package/templates/sacred/LINEAGES.md +52 -0
- package/templates/sacred/README.md +20 -0
- package/templates/sacred/THEOLOGICAL-ARC.md +69 -0
- package/templates/sacred/catholic/manifest.yaml +93 -0
- package/templates/sacred/islamic-hafs/manifest.yaml +134 -0
- package/templates/sacred/islamic-warsh/manifest.yaml +134 -0
- package/templates/sacred/jewish/manifest.yaml +56 -0
- package/templates/sacred/orthodox/manifest.yaml +98 -0
- package/templates/sacred/pali/manifest.yaml +20 -0
- package/templates/sacred/protestant/manifest.yaml +86 -0
- package/templates/sacred/sanskrit/manifest.yaml +20 -0
- package/templates/sacred/tewahedo/manifest.yaml +106 -0
- package/templates/sacred/tibetan/manifest.yaml +20 -0
- package/templates/technical/AUDIENCE.md +26 -0
- package/templates/technical/DEPENDENCIES.md +19 -0
- package/templates/technical/DOC-BRIEF.md +45 -0
- package/templates/technical/PROCEDURES.md +37 -0
- package/templates/technical/REFERENCES.md +36 -0
- package/templates/technical/SYSTEM.md +25 -0
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
creative_pillar: structure
|
|
3
|
+
always_load_for: [discuss, plan, draft, editor-review]
|
|
4
|
+
authority: project
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Argument Map
|
|
8
|
+
|
|
9
|
+
Academic projects use this file instead of PLOT-GRAPH.md. Track the argument's movement by claim, evidence, counterclaim, method, transition, and reader-state shift.
|
|
10
|
+
|
|
11
|
+
## Argument Spine
|
|
12
|
+
|
|
13
|
+
**Thesis:** {{THESIS}}
|
|
14
|
+
**Central research question:** {{CENTRAL_QUESTION}}
|
|
15
|
+
**Method or framework:** {{METHOD}}
|
|
16
|
+
**Reader starts here:** {{READER_START}}
|
|
17
|
+
**Reader should land here:** {{READER_END}}
|
|
18
|
+
|
|
19
|
+
## Claim Sequence
|
|
20
|
+
|
|
21
|
+
### {{CLAIM_NAME}}
|
|
22
|
+
|
|
23
|
+
**Claim:** {{CLAIM}}
|
|
24
|
+
**Purpose in argument:** {{PURPOSE}}
|
|
25
|
+
**Evidence:** {{EVIDENCE}}
|
|
26
|
+
**Counterclaim or limitation:** {{COUNTERCLAIM}}
|
|
27
|
+
**Transition into this claim:** {{TRANSITION_IN}}
|
|
28
|
+
**Transition out of this claim:** {{TRANSITION_OUT}}
|
|
29
|
+
|
|
30
|
+
#### Subject dynamics
|
|
31
|
+
|
|
32
|
+
**Reader starts here:** {{CLAIM_READER_START}}
|
|
33
|
+
**Reader should move toward:** {{CLAIM_READER_SHIFT}}
|
|
34
|
+
**Pressure or friction:** {{CLAIM_PRESSURE}}
|
|
35
|
+
**Interaction pattern:** {{CLAIM_INTERACTION}} (claim vs. counterclaim, evidence vs. objection, theory vs. case, method vs. limitation)
|
|
36
|
+
**Watchpoints:** {{CLAIM_WATCHPOINTS}}
|
|
37
|
+
|
|
38
|
+
## Open Questions
|
|
39
|
+
|
|
40
|
+
{{OPEN_QUESTIONS}}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
creative_pillar: cast
|
|
3
|
+
always_load_for: [discuss, plan, draft, editor-review]
|
|
4
|
+
authority: project
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Concepts
|
|
8
|
+
|
|
9
|
+
Academic projects use this file instead of CHARACTERS.md. Track the concepts, schools, claims, counterclaims, methods, terms, and analytical positions that behave like the active cast of the argument.
|
|
10
|
+
|
|
11
|
+
## {{CONCEPT_NAME}}
|
|
12
|
+
|
|
13
|
+
**Concept type:** {{CONCEPT_TYPE}} (thesis, counterclaim, method, term, framework, case, evidence cluster)
|
|
14
|
+
**Role in argument:** {{ROLE}}
|
|
15
|
+
**Current position:** {{CURRENT_POSITION}}
|
|
16
|
+
**Key sources:** {{SOURCES}}
|
|
17
|
+
**Common misunderstanding:** {{MISUNDERSTANDING}}
|
|
18
|
+
**Pressure point:** {{PRESSURE_POINT}}
|
|
19
|
+
|
|
20
|
+
### Subject dynamics
|
|
21
|
+
|
|
22
|
+
**Reader starts here:** {{READER_START}}
|
|
23
|
+
**Reader should move toward:** {{READER_SHIFT}}
|
|
24
|
+
**Pressure or friction:** {{PRESSURE_OR_FRICTION}}
|
|
25
|
+
**Interaction pattern:** {{INTERACTION_PATTERN}} (claim vs. counterclaim, method vs. limitation, evidence vs. objection, theory vs. case)
|
|
26
|
+
**Watchpoints:** {{WATCHPOINTS}}
|
|
27
|
+
|
|
28
|
+
### Evidence state
|
|
29
|
+
|
|
30
|
+
**Supported by:** {{SUPPORTED_BY}}
|
|
31
|
+
**Challenged by:** {{CHALLENGED_BY}}
|
|
32
|
+
**Needs support:** {{NEEDS_SUPPORT}}
|
|
33
|
+
|
|
34
|
+
_Last touched: {{LAST_TOUCHED}}_
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
creative_pillar: world
|
|
3
|
+
always_load_for: [discuss, plan, draft, editor-review]
|
|
4
|
+
authority: project
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Academic Context
|
|
8
|
+
|
|
9
|
+
Academic projects use this file instead of WORLD.md. Track the intellectual landscape, field assumptions, institutional context, historical frame, source boundaries, and terminology.
|
|
10
|
+
|
|
11
|
+
## Field Context
|
|
12
|
+
|
|
13
|
+
**Discipline or field:** {{FIELD}}
|
|
14
|
+
**Conversation:** {{CONVERSATION}}
|
|
15
|
+
**Key debates:** {{KEY_DEBATES}}
|
|
16
|
+
**Methodological boundaries:** {{METHOD_BOUNDARIES}}
|
|
17
|
+
**Ethical boundaries:** {{ETHICAL_BOUNDARIES}}
|
|
18
|
+
|
|
19
|
+
## Subject Dynamics
|
|
20
|
+
|
|
21
|
+
**Reader starts here:** {{READER_START}}
|
|
22
|
+
**Reader should move toward:** {{READER_SHIFT}}
|
|
23
|
+
**Pressure or friction:** {{PRESSURE_OR_FRICTION}}
|
|
24
|
+
**Interaction pattern:** {{INTERACTION_PATTERN}} (field consensus vs. dispute, method vs. limitation, source tradition vs. new evidence)
|
|
25
|
+
**Watchpoints:** {{WATCHPOINTS}}
|
|
26
|
+
|
|
27
|
+
## Terms
|
|
28
|
+
|
|
29
|
+
{{TERMS}}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
---
|
|
2
|
+
creative_pillar: work
|
|
3
|
+
always_load_for: [discuss, plan]
|
|
4
|
+
authority: project
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Proposal
|
|
8
|
+
|
|
9
|
+
## Project Claim
|
|
10
|
+
|
|
11
|
+
**Working title:** {{TITLE}}
|
|
12
|
+
**Research question:** {{RESEARCH_QUESTION}}
|
|
13
|
+
**Thesis or hypothesis:** {{THESIS}}
|
|
14
|
+
**Field or discipline:** {{FIELD}}
|
|
15
|
+
**Audience:** {{AUDIENCE}}
|
|
16
|
+
|
|
17
|
+
## Reader Journey
|
|
18
|
+
|
|
19
|
+
**Reader starts with:** {{READER_START}}
|
|
20
|
+
**Reader should move toward:** {{READER_SHIFT}}
|
|
21
|
+
**Main pressure:** {{MAIN_PRESSURE}} (gap, dispute, misconception, limitation, ethical concern, methodological risk)
|
|
22
|
+
**Key interaction:** {{KEY_INTERACTION}} (claim vs. counterclaim, evidence vs. objection, method vs. limitation, theory vs. case)
|
|
23
|
+
|
|
24
|
+
## Scope
|
|
25
|
+
|
|
26
|
+
**In scope:** {{IN_SCOPE}}
|
|
27
|
+
**Out of scope:** {{OUT_OF_SCOPE}}
|
|
28
|
+
**Primary sources or data:** {{PRIMARY_SOURCES}}
|
|
29
|
+
**Secondary sources:** {{SECONDARY_SOURCES}}
|
|
30
|
+
|
|
31
|
+
## Success Criteria
|
|
32
|
+
|
|
33
|
+
{{SUCCESS_CRITERIA}}
|
|
34
|
+
|
|
35
|
+
## Open Questions
|
|
36
|
+
|
|
37
|
+
{{OPEN_QUESTIONS}}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
creative_pillar: themes
|
|
3
|
+
always_load_for: [discuss, plan, draft, editor-review]
|
|
4
|
+
authority: project
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Research Questions
|
|
8
|
+
|
|
9
|
+
Academic projects use this file instead of THEMES.md. Track research questions, subquestions, unresolved tensions, claims, and reader-state movement.
|
|
10
|
+
|
|
11
|
+
## {{QUESTION_NAME}}
|
|
12
|
+
|
|
13
|
+
**Research question:** {{QUESTION}}
|
|
14
|
+
**Working answer:** {{WORKING_ANSWER}} (or "deliberately unresolved")
|
|
15
|
+
**Why it matters:** {{WHY_IT_MATTERS}}
|
|
16
|
+
**Reader starts here:** {{READER_START}}
|
|
17
|
+
**Reader should move toward:** {{READER_SHIFT}}
|
|
18
|
+
**Pressure or friction:** {{PRESSURE_OR_FRICTION}} (gap, dispute, limitation, counterclaim, methodological risk)
|
|
19
|
+
**Interaction pattern:** {{INTERACTION_PATTERN}} (claim vs. counterclaim, source vs. source, method vs. limitation, evidence vs. interpretation)
|
|
20
|
+
**Evidence needed:** {{EVIDENCE_NEEDED}}
|
|
21
|
+
**Sections where it appears:** {{SECTION_LIST}}
|
|
22
|
+
**Watchpoints:** {{WATCHPOINTS}}
|
|
23
|
+
|
|
24
|
+
_Last touched: {{LAST_TOUCHED}}_
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
{
|
|
2
|
+
"scriveno_version": "2.0.5",
|
|
3
|
+
"work_type": "",
|
|
4
|
+
"group": "",
|
|
5
|
+
"command_unit": "",
|
|
6
|
+
"developer_mode": false,
|
|
7
|
+
"created_at": "",
|
|
8
|
+
"updated_at": "",
|
|
9
|
+
|
|
10
|
+
"autopilot": {
|
|
11
|
+
"enabled": false,
|
|
12
|
+
"profile": "guided",
|
|
13
|
+
"custom_checkpoints": []
|
|
14
|
+
},
|
|
15
|
+
|
|
16
|
+
"voice": {
|
|
17
|
+
"calibrated": false,
|
|
18
|
+
"last_calibration": null,
|
|
19
|
+
"drift_threshold": 0.3
|
|
20
|
+
},
|
|
21
|
+
|
|
22
|
+
"draft": {
|
|
23
|
+
"rigor": "standard",
|
|
24
|
+
"context_profile": "standard",
|
|
25
|
+
"pitfalls_enabled": true
|
|
26
|
+
},
|
|
27
|
+
|
|
28
|
+
"export": {
|
|
29
|
+
"default_format": "docx_manuscript",
|
|
30
|
+
"include_front_matter": true,
|
|
31
|
+
"include_back_matter": true,
|
|
32
|
+
"manuscript_format": {
|
|
33
|
+
"font": "Times New Roman",
|
|
34
|
+
"size": 12,
|
|
35
|
+
"spacing": "double",
|
|
36
|
+
"margins": "1in"
|
|
37
|
+
}
|
|
38
|
+
},
|
|
39
|
+
|
|
40
|
+
"translation": {
|
|
41
|
+
"source_language": "en",
|
|
42
|
+
"target_languages": [],
|
|
43
|
+
"name_handling": "keep_original",
|
|
44
|
+
"measurement_system": "source"
|
|
45
|
+
},
|
|
46
|
+
|
|
47
|
+
"technical": {
|
|
48
|
+
"audience_level": "mixed",
|
|
49
|
+
"prerequisite_knowledge": [],
|
|
50
|
+
"supported_environment": "",
|
|
51
|
+
"supported_versions": [],
|
|
52
|
+
"source_of_truth": [],
|
|
53
|
+
"review_mode": "accuracy_first"
|
|
54
|
+
},
|
|
55
|
+
|
|
56
|
+
"collaboration": {
|
|
57
|
+
"tracks_enabled": false,
|
|
58
|
+
"default_track": "canon"
|
|
59
|
+
},
|
|
60
|
+
|
|
61
|
+
"illustration": {
|
|
62
|
+
"style": null,
|
|
63
|
+
"cover_enabled": false,
|
|
64
|
+
"interior_enabled": false
|
|
65
|
+
},
|
|
66
|
+
|
|
67
|
+
"git": {
|
|
68
|
+
"auto_commit": true,
|
|
69
|
+
"commit_message_style": "descriptive",
|
|
70
|
+
"branching_strategy": "none"
|
|
71
|
+
}
|
|
72
|
+
}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Pitfall pack: comic
|
|
2
|
+
|
|
3
|
+
*Type-specific traps for comic and graphic novel drafting. Loaded after WRITING-RULES.md. STYLE-GUIDE.md wins where it conflicts.*
|
|
4
|
+
|
|
5
|
+
## Script-versus-art boundary
|
|
6
|
+
|
|
7
|
+
- Caption as substitute for image. If the caption tells you what the panel shows, cut the caption.
|
|
8
|
+
- Direction the artist cannot deliver ("she feels nostalgic", "the city remembers"). Translate to visual cues.
|
|
9
|
+
- Over-specifying every panel composition. Trust the artist on framing unless the moment requires a specific shot.
|
|
10
|
+
- Under-specifying scale, character placement, or beat count. The script must give the artist enough.
|
|
11
|
+
|
|
12
|
+
## Dialogue and balloons
|
|
13
|
+
|
|
14
|
+
- Speech balloons that exceed the panel's visual real estate. Trim. A balloon should not eat the figure.
|
|
15
|
+
- Long speeches where action would carry the beat.
|
|
16
|
+
- Sound-effect captions doing work the artist's lettering should do.
|
|
17
|
+
- Thought balloons stacked on internal monologue captions. Pick one mode.
|
|
18
|
+
- "Continued..." chains across many panels. If a speech needs three balloons, it needs less speech.
|
|
19
|
+
|
|
20
|
+
## Pacing and panel rhythm
|
|
21
|
+
|
|
22
|
+
- Three-panel rows on every page. Vary panel count for tempo.
|
|
23
|
+
- Splash pages used cosmetically rather than for emphasis.
|
|
24
|
+
- Talking-head pages without environmental change.
|
|
25
|
+
- Reaction shots stacked. One landed reaction beats three weak ones.
|
|
26
|
+
- Page turns that do not deliver a beat. The turn is a tool; use it.
|
|
27
|
+
|
|
28
|
+
## Caption voice
|
|
29
|
+
|
|
30
|
+
- Voiceover narration that explains what the panel shows.
|
|
31
|
+
- Voiceover that competes with dialogue for the reader's attention in the same beat.
|
|
32
|
+
- Tense drift between caption and image (caption past tense, image present moment).
|
|
33
|
+
- Captions that hedge ("perhaps it was the way she looked at him"). The image is the evidence; commit.
|
|
34
|
+
|
|
35
|
+
## Genre stock devices
|
|
36
|
+
|
|
37
|
+
- Superhero: origin flashback in issue one. Cliched unless interrogated.
|
|
38
|
+
- Slice-of-life: rain on the window as mood marker. Overused.
|
|
39
|
+
- Horror: cat jump scare. Cliched.
|
|
40
|
+
- Manga-derived: speed lines on every emotional beat.
|
|
41
|
+
- Underground: shock images in service of nothing. Earn it.
|
|
42
|
+
|
|
43
|
+
## Sequential storytelling traps
|
|
44
|
+
|
|
45
|
+
- Action sequences that fail to track who is where. Establish geography in the first panel of an action beat.
|
|
46
|
+
- Flashbacks without visual signal (color shift, border change, period detail). Reader gets lost.
|
|
47
|
+
- Multi-character scenes where two characters look identical. Costume, posture, or framing must distinguish.
|
|
48
|
+
- Time skips inside a single page that the layout does not signal.
|
|
49
|
+
|
|
50
|
+
## Closing pitfalls
|
|
51
|
+
|
|
52
|
+
- Final panel of the issue is a reaction shot to a question the reader cannot answer yet. Hooks should land on a turn, not a stare.
|
|
53
|
+
- Last-page splash that just shows the protagonist looking at the horizon.
|
|
54
|
+
- "To be continued..." over an image that already feels like an ending.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Pitfall pack: commentary
|
|
2
|
+
|
|
3
|
+
*Type-specific traps for sacred-text commentary drafting. Applies across traditions (biblical, Quranic, Talmudic, Vedic, Buddhist, etc.). Loaded after WRITING-RULES.md. STYLE-GUIDE.md and DOCTRINES.md still win where they conflict; this pack is general craft, not doctrine.*
|
|
4
|
+
|
|
5
|
+
## Register drift
|
|
6
|
+
|
|
7
|
+
Commentary moves between registers: exegetical (analytical), pastoral (applied), homiletic (proclamational), devotional (responsive). Drift happens when the writer slides from one to another mid-paragraph without signaling.
|
|
8
|
+
|
|
9
|
+
- Exegetical analysis suddenly turning into pastoral exhortation in the same sentence.
|
|
10
|
+
- Devotional warmth bleeding into what should be a tight philological note.
|
|
11
|
+
- "We" that sometimes means the scholarly reader and sometimes means the worshiping community. Hold one referent at a time.
|
|
12
|
+
- Quoting the source text in one register (formal, traditional rendering) and paraphrasing it later in another (colloquial). Match register or signal the shift.
|
|
13
|
+
|
|
14
|
+
## Anachronism
|
|
15
|
+
|
|
16
|
+
- Modern psychological vocabulary applied to ancient figures ("Moses processed his trauma", "Arjuna struggled with imposter syndrome"). Avoid unless the move is deliberate and signposted.
|
|
17
|
+
- Modern political categories projected backward ("the prophet's progressive stance"). Use period-appropriate framing.
|
|
18
|
+
- Contemporary metaphors that erase historical context ("the disciples were the original startup team"). Cute, almost always wrong.
|
|
19
|
+
- Translating concepts that have no cognate ("dharma" as "duty", "chesed" as "kindness") without flagging the loss.
|
|
20
|
+
|
|
21
|
+
## Doctrinal precision
|
|
22
|
+
|
|
23
|
+
- Asserting interpretations as the only reading when interpretive traditions disagree. Acknowledge the range or stay narrow.
|
|
24
|
+
- Smuggling in doctrinal claims without citation to authoritative sources (church fathers, hadith, mishnah, classical commentaries).
|
|
25
|
+
- Conflating the writer's tradition's reading with universal "what the text means".
|
|
26
|
+
- Using denominational shorthand without defining it for non-specialist readers.
|
|
27
|
+
|
|
28
|
+
## Source-handling pitfalls
|
|
29
|
+
|
|
30
|
+
- Quoting a passage in a translation without naming the translation.
|
|
31
|
+
- Treating one manuscript tradition as if it were uncontested. Note variant readings where they bear on the argument.
|
|
32
|
+
- Citing a secondary source when a primary source exists.
|
|
33
|
+
- Over-reliance on a single classical commentator without acknowledging others.
|
|
34
|
+
- Ignoring transmission history when it bears on the passage's authority or meaning.
|
|
35
|
+
|
|
36
|
+
## Sentimentality and triumphalism
|
|
37
|
+
|
|
38
|
+
- Closing every section with an inspirational lift.
|
|
39
|
+
- Reading every passage as already pointing to the writer's preferred theological conclusion.
|
|
40
|
+
- Hagiographic treatment of figures the text itself depicts complexly.
|
|
41
|
+
- Hostile straw-man treatment of other traditions or interpretations.
|
|
42
|
+
|
|
43
|
+
## Stock phrases
|
|
44
|
+
|
|
45
|
+
- "What this passage really tells us is..."
|
|
46
|
+
- "In our modern world..."
|
|
47
|
+
- "Now more than ever..."
|
|
48
|
+
- "The deeper meaning here..."
|
|
49
|
+
- "What the original audience would have understood..." (without evidence)
|
|
50
|
+
|
|
51
|
+
## Cross-reference discipline
|
|
52
|
+
|
|
53
|
+
- Daisy-chains of cross-references that obscure the local meaning of the passage.
|
|
54
|
+
- Forcing typological or allegorical readings where the text does not warrant them.
|
|
55
|
+
- Citing parallel passages without showing how the parallel illuminates the current verse.
|
|
56
|
+
|
|
57
|
+
## Closing pitfalls
|
|
58
|
+
|
|
59
|
+
- Application section that ignores the exegetical work above it.
|
|
60
|
+
- "Let us therefore..." sermon move when the genre is commentary, not sermon.
|
|
61
|
+
- A closing prayer or doxology in what is meant to be a critical edition.
|
|
62
|
+
- Promising to address the difficulty in a future volume that may never come.
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Pitfall pack: memoir
|
|
2
|
+
|
|
3
|
+
*Type-specific traps for memoir drafting. Loaded after WRITING-RULES.md. STYLE-GUIDE.md wins where it conflicts.*
|
|
4
|
+
|
|
5
|
+
## Voice traps
|
|
6
|
+
|
|
7
|
+
- The retrospective narrator who knows everything. The remembered self does not yet know the lesson; let them not know.
|
|
8
|
+
- Therapy-speak imported into prose ("I was processing", "I held space for", "my inner child"). Use it only if the writer's voice in STYLE-GUIDE.md uses it.
|
|
9
|
+
- The wisdom voice every paragraph. Insight earned by scene beats insight stated.
|
|
10
|
+
- "Looking back now, I see that..." as connective tissue. Once is fine. Three times in a chapter is a tic.
|
|
11
|
+
|
|
12
|
+
## Telling not showing
|
|
13
|
+
|
|
14
|
+
- Naming the feeling instead of rendering the moment. "I was devastated": what did the body do, what did the eye land on, what did you fail to do.
|
|
15
|
+
- Summarizing relationships ("My father was a complicated man"). Show one scene that makes the complication visible.
|
|
16
|
+
- Time-collapsed reflection ("For years afterward, I would..."). Earn it with a specific later moment.
|
|
17
|
+
|
|
18
|
+
## Truth and embellishment
|
|
19
|
+
|
|
20
|
+
- Composite characters or invented dialogue without disclosure. Disclose in front matter or footnote per the writer's chosen convention.
|
|
21
|
+
- Memories described with novelistic certainty ("the rain hit the window in fat drops"). Acknowledge memory's edges where useful.
|
|
22
|
+
- Hindsight-loaded foreshadowing ("I had no idea this would be the last time"). Often hollow. Cut or earn.
|
|
23
|
+
|
|
24
|
+
## Self-presentation
|
|
25
|
+
|
|
26
|
+
- Self-flagellation as flex (excessive humility that draws attention to the writer's virtue). Watch for it.
|
|
27
|
+
- Heroizing the past self. The reader should see the flaw before the writer names it.
|
|
28
|
+
- Other-people-as-props (loved ones rendered only in service of the writer's arc). Give them their own gravity.
|
|
29
|
+
|
|
30
|
+
## Stock phrases
|
|
31
|
+
|
|
32
|
+
- "Little did I know"
|
|
33
|
+
- "Looking back, I realize"
|
|
34
|
+
- "It would be years before I understood"
|
|
35
|
+
- "I was just a kid" (when not interrogated)
|
|
36
|
+
- "And just like that"
|
|
37
|
+
|
|
38
|
+
## Structural pitfalls
|
|
39
|
+
|
|
40
|
+
- Strict chronology when associative structure serves better, or vice versa. Match form to subject.
|
|
41
|
+
- Resolving every thread. Memoir tolerates loose ends; life had them.
|
|
42
|
+
- The lesson chapter at the end. The lessons should already be in the scenes.
|
|
43
|
+
|
|
44
|
+
## Closing pitfalls
|
|
45
|
+
|
|
46
|
+
- The reflective coda explaining what we just read.
|
|
47
|
+
- "I am still that girl, in some ways" or its variants.
|
|
48
|
+
- Closing on a hopeful generality ("we go on", "love endures"). Stay specific.
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# Pitfall pack: novel
|
|
2
|
+
|
|
3
|
+
*Type-specific traps for novel drafting. Loaded by the drafter, line-editor, and polish commands after WRITING-RULES.md. STYLE-GUIDE.md still wins where it conflicts.*
|
|
4
|
+
|
|
5
|
+
## Filter words
|
|
6
|
+
|
|
7
|
+
These verbs interpose the narrator between reader and event. Cut them unless the POV explicitly observes itself.
|
|
8
|
+
|
|
9
|
+
- "she felt", "he felt the X": describe the sensation directly
|
|
10
|
+
- "she saw", "he noticed", "she watched": describe the thing itself
|
|
11
|
+
- "she heard": describe the sound
|
|
12
|
+
- "she thought", "she wondered", "she realized": render the thought as direct interiority or action
|
|
13
|
+
- "she seemed", "appeared to": commit to what is, or commit to her reading of it
|
|
14
|
+
|
|
15
|
+
## Telling not showing
|
|
16
|
+
|
|
17
|
+
- Emotion words on the nose ("she was furious", "he was nervous"). Replace with body, action, or implication.
|
|
18
|
+
- Backstory dumps after a name introduction ("Sarah, who had grown up in Maine and once worked as a..."). Drip feed.
|
|
19
|
+
- Author intrusion ("little did she know", "if only he had realized"). Narrator should not signal future to reader.
|
|
20
|
+
|
|
21
|
+
## POV breaches
|
|
22
|
+
|
|
23
|
+
- Head-hopping in close third. If the chapter is in Marcus's POV, you cannot describe Sarah's interior thought, only what Marcus perceives.
|
|
24
|
+
- Knowing what cannot be known. A first-person narrator does not see their own face unless looking in a mirror.
|
|
25
|
+
- Naming things the POV character would not name. A child's POV does not say "diorite countertop"; an unfamiliar object is unfamiliar.
|
|
26
|
+
|
|
27
|
+
## Dialogue traps
|
|
28
|
+
|
|
29
|
+
- Talking-head scenes (dialogue without grounding action, gesture, or setting beat). Insert beats.
|
|
30
|
+
- As-you-know dialogue (characters explaining things to each other for the reader's benefit). Cut, or break the exposition into action.
|
|
31
|
+
- All characters sounding like the narrator. Each speaker needs a distinct lexicon, rhythm, and verbal tic.
|
|
32
|
+
- "She said with a smile" / "he said angrily": show the smile, show the anger, drop the adverb on "said".
|
|
33
|
+
|
|
34
|
+
## Stock phrases (genre overuse)
|
|
35
|
+
|
|
36
|
+
- Romance: "her breath caught", "his heart raced", "lost in his eyes", "butterflies in her stomach"
|
|
37
|
+
- Thriller: "cold sweat", "heart pounding in his ears", "every fiber of his being", "she didn't have time to think"
|
|
38
|
+
- Fantasy: "ancient evil", "primal magic", "the prophecy foretold", "older than time itself"
|
|
39
|
+
- Literary: "the weight of years", "in the silence between them", "she let the moment hang"
|
|
40
|
+
|
|
41
|
+
If you reach for a phrase you've read before, the writer has too. Replace with something specific to this character, this image system, this scene.
|
|
42
|
+
|
|
43
|
+
## Pacing pitfalls
|
|
44
|
+
|
|
45
|
+
- Three consecutive paragraphs of similar length. Vary.
|
|
46
|
+
- Scenes that begin with weather or waking. Cliched openers.
|
|
47
|
+
- Time skips signaled with "Three weeks later" alone. Show the gap with a concrete shift in setting or state.
|
|
48
|
+
|
|
49
|
+
## Closing pitfalls
|
|
50
|
+
|
|
51
|
+
- Wrapping the chapter with a thematic statement. Trust the reader.
|
|
52
|
+
- "And that was the day everything changed." Cut.
|
|
53
|
+
- A character looking at the sky / horizon / their reflection as an emotional capstone. Overused.
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# Pitfall pack: poetry collection
|
|
2
|
+
|
|
3
|
+
*Type-specific traps for poetry drafting. Loaded after WRITING-RULES.md. STYLE-GUIDE.md wins where it conflicts.*
|
|
4
|
+
|
|
5
|
+
## Image traps
|
|
6
|
+
|
|
7
|
+
- Generic nature image as emotional shorthand (autumn leaves for melancholy, rain for grief, dawn for hope). Earn the image with specificity or surprise.
|
|
8
|
+
- The moon used as a metaphor without a fresh angle.
|
|
9
|
+
- The body as landscape without a fresh angle ("rivers of veins", "mountains of shoulders").
|
|
10
|
+
- Mirror, shadow, and reflection imagery as standard isolation tropes.
|
|
11
|
+
- Birds, especially when symbolic ("a bird took flight from her chest"). Watch the reach for them.
|
|
12
|
+
|
|
13
|
+
## Diction traps
|
|
14
|
+
|
|
15
|
+
- Latinate abstractions in lyric registers ("incandescent", "ineffable", "ephemeral") unless the writer's voice in STYLE-GUIDE.md is comfortable there.
|
|
16
|
+
- "Soul" used loosely. Earn it.
|
|
17
|
+
- Adjectives stacked on the same noun ("the deep, dark, endless sea"). Pick one.
|
|
18
|
+
- Capitalized abstractions (Love, Death, Time, Memory). Lowercase forces the writer to do the work.
|
|
19
|
+
- "Whisper" as a verb of choice for almost everything. Watch.
|
|
20
|
+
|
|
21
|
+
## Rhythm and music
|
|
22
|
+
|
|
23
|
+
- Iambic drift in free verse. If you wrote a sonnet, write it. If not, vary.
|
|
24
|
+
- End-stopped lines all the way down. Use enjambment to break expectations.
|
|
25
|
+
- Lines broken at every conjunction. Let lines do work.
|
|
26
|
+
- Forcing a rhyme that warps the syntax. Cut the rhyme or rewrite the line.
|
|
27
|
+
- Unintended internal rhyme producing nursery cadence in serious poems.
|
|
28
|
+
|
|
29
|
+
## Sentimentality
|
|
30
|
+
|
|
31
|
+
- Tears as the closing image.
|
|
32
|
+
- The grandmother as metonym for ancestral wisdom.
|
|
33
|
+
- Childhood photograph as elegy device.
|
|
34
|
+
- The lover described entirely through their effect on the speaker.
|
|
35
|
+
- Suffering rendered as nobility without complication.
|
|
36
|
+
|
|
37
|
+
## Confessional pitfalls
|
|
38
|
+
|
|
39
|
+
- Diary entries in line breaks. The line break must do work.
|
|
40
|
+
- Universalizing too fast ("we all carry our wounds"). Stay specific.
|
|
41
|
+
- Therapeutic tidiness. Real grief, rage, or longing rarely arrives shaped.
|
|
42
|
+
- Naming the feeling in the title and again in the closing line.
|
|
43
|
+
|
|
44
|
+
## Form pitfalls
|
|
45
|
+
|
|
46
|
+
- Free verse that is broken prose. Make the breaks earn their keep.
|
|
47
|
+
- Sonnet variations that abandon the volta. The volta is the form's gift; use it.
|
|
48
|
+
- Prose poems with no compression. Test against actual prose; if nothing is gained by calling it poetry, it is prose.
|
|
49
|
+
- Persona poems that do not commit to the persona.
|
|
50
|
+
|
|
51
|
+
## Closing pitfalls
|
|
52
|
+
|
|
53
|
+
- The final line that explains the poem.
|
|
54
|
+
- Ending on a question that the body of the poem already answers.
|
|
55
|
+
- Triple-spaced final stanza as gravitas. Earn the white space.
|
|
56
|
+
- "And so" / "And yet" / "But still" as the move into the close. Tic.
|
|
57
|
+
|
|
58
|
+
## Cohesion across the collection
|
|
59
|
+
|
|
60
|
+
- Same image used across multiple poems without development.
|
|
61
|
+
- The same closing move (return-to-childhood, return-to-body, return-to-grief) every fourth poem.
|
|
62
|
+
- Section breaks that group thematically with no internal arc inside each section.
|
|
63
|
+
- A title poem that the rest of the collection depends on for legibility. The collection should hold without it.
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# Pitfall pack: research paper
|
|
2
|
+
|
|
3
|
+
*Type-specific traps for research paper drafting. Loaded after WRITING-RULES.md. STYLE-GUIDE.md wins where it conflicts.*
|
|
4
|
+
|
|
5
|
+
## Argument hygiene
|
|
6
|
+
|
|
7
|
+
- Hedge stacks ("it may be argued that perhaps the data could potentially suggest"). One hedge or none.
|
|
8
|
+
- Claims that exceed the evidence. If the data shows correlation, do not write causation.
|
|
9
|
+
- "Significant" without a referent. Statistical significance, effect size, or substantive importance? Name it.
|
|
10
|
+
- "Robust", "novel", "first of its kind" without justification. Cut or substantiate.
|
|
11
|
+
|
|
12
|
+
## Passive voice and missing agents
|
|
13
|
+
|
|
14
|
+
- "It has been shown that". Show by whom, when, in which study. Cite.
|
|
15
|
+
- "The data was analyzed". By whom, with what method.
|
|
16
|
+
- Active voice is acceptable in modern academic writing in most fields. Check the target journal's house style; do not default to passive out of habit.
|
|
17
|
+
|
|
18
|
+
## Citation pitfalls
|
|
19
|
+
|
|
20
|
+
- Citations clustered at the end of a paragraph instead of attached to the specific claim they support.
|
|
21
|
+
- Citing review articles when primary sources are warranted.
|
|
22
|
+
- Citing the writer's prior work without disclosure.
|
|
23
|
+
- Citation laundering (citing a paper that cited a paper that cited the original; cite the original).
|
|
24
|
+
- Missing citations on claims that read as common knowledge but are not in the target field.
|
|
25
|
+
|
|
26
|
+
## Methodology traps
|
|
27
|
+
|
|
28
|
+
- Methods that conceal choices ("standard procedures were followed"). Spell out which standard, which version.
|
|
29
|
+
- Sample sizes without justification.
|
|
30
|
+
- Exclusion criteria mentioned in passing instead of in a dedicated subsection.
|
|
31
|
+
- Lab tooling cited without version or configuration.
|
|
32
|
+
- "Data not shown" as a substitute for actually showing it.
|
|
33
|
+
|
|
34
|
+
## Results section pitfalls
|
|
35
|
+
|
|
36
|
+
- Discussion bleeding into Results. Keep them separate. Results report; Discussion interprets.
|
|
37
|
+
- p-values without effect sizes.
|
|
38
|
+
- Visualizations that compress evidence into a misleading shape (broken y-axes, cherry-picked time windows).
|
|
39
|
+
- Tables that duplicate figures.
|
|
40
|
+
|
|
41
|
+
## Discussion section pitfalls
|
|
42
|
+
|
|
43
|
+
- Restating Results instead of interpreting them.
|
|
44
|
+
- Limitations as a single sentence near the end. Take limitations seriously; they are evidence of rigor.
|
|
45
|
+
- Speculative implications presented as findings.
|
|
46
|
+
- Failing to engage with conflicting prior work.
|
|
47
|
+
|
|
48
|
+
## Stock phrases to avoid
|
|
49
|
+
|
|
50
|
+
- "Recent advances in"
|
|
51
|
+
- "It is well known that" (without citation)
|
|
52
|
+
- "Surprisingly" (often a tell that the framing is weak)
|
|
53
|
+
- "More research is needed" (true but useless without specifying what)
|
|
54
|
+
- "To the best of our knowledge"
|
|
55
|
+
|
|
56
|
+
## Voice tics
|
|
57
|
+
|
|
58
|
+
- "We" when the writer is solo. Match journal convention.
|
|
59
|
+
- "Obviously", "clearly", "of course". If it were obvious, you would not be writing the paper.
|
|
60
|
+
- Sentences that start with "However" three paragraphs in a row.
|
|
61
|
+
|
|
62
|
+
## Closing pitfalls
|
|
63
|
+
|
|
64
|
+
- A conclusion that summarizes findings already in the abstract. Add interpretation, implication, or open question.
|
|
65
|
+
- "We hope that..." appeals.
|
|
66
|
+
- Future work bullets that read as an apology.
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# Pitfall pack: runbook
|
|
2
|
+
|
|
3
|
+
*Type-specific traps for runbook drafting. Loaded after WRITING-RULES.md. STYLE-GUIDE.md wins where it conflicts.*
|
|
4
|
+
|
|
5
|
+
## Audience and stakes
|
|
6
|
+
|
|
7
|
+
A runbook is read by someone tired, paged at 3am, and under pressure. Optimize for clarity over elegance.
|
|
8
|
+
|
|
9
|
+
- Marketing language ("seamless", "robust", "world-class"). Cut.
|
|
10
|
+
- Friendly conversational asides ("Now, this is the fun part!"). Cut.
|
|
11
|
+
- Backstory or history of the system in step bodies. Move to a separate "Context" section.
|
|
12
|
+
- Caveats stacked before the action ("Note that in some cases, depending on configuration, you may want to..."). Lead with the action; put caveats after.
|
|
13
|
+
|
|
14
|
+
## Imperative mood
|
|
15
|
+
|
|
16
|
+
- Passive voice in steps ("The service should be restarted"). Use active imperative: "Restart the service."
|
|
17
|
+
- "We" or "you" mood mixed in the same procedure. Pick one and hold it.
|
|
18
|
+
- Conditional verbs disguised as direction ("you might want to consider"). Be direct: "Run X if Y."
|
|
19
|
+
|
|
20
|
+
## Ambiguity traps
|
|
21
|
+
|
|
22
|
+
- "Run the script": which script, where, with what flags. Always name the file path and exact command.
|
|
23
|
+
- "Restart the service": which service, on which host, with which command.
|
|
24
|
+
- "Check the logs": which log, at what path, looking for what string.
|
|
25
|
+
- Pronouns without clear antecedents ("it should now be running"). Replace with the noun.
|
|
26
|
+
- "Simply" and "just". They are lies told to the reader and signal you have not thought through the step.
|
|
27
|
+
|
|
28
|
+
## Missing preconditions
|
|
29
|
+
|
|
30
|
+
Every procedure should declare:
|
|
31
|
+
- What state the system must be in before starting
|
|
32
|
+
- What credentials, tooling, or access the operator needs
|
|
33
|
+
- What environment variables or config must be set
|
|
34
|
+
- What other procedures must have completed first
|
|
35
|
+
|
|
36
|
+
If any of these are missing, the runbook fails the moment someone less senior runs it.
|
|
37
|
+
|
|
38
|
+
## Verification and rollback
|
|
39
|
+
|
|
40
|
+
- Steps that change state with no verification step after. Always include "Verify by..." with an exact command and expected output.
|
|
41
|
+
- Procedures with no rollback section. Every change-step needs an undo.
|
|
42
|
+
- "If something goes wrong, contact X." Inadequate. Spell out the diagnostic flow.
|
|
43
|
+
|
|
44
|
+
## Ordering pitfalls
|
|
45
|
+
|
|
46
|
+
- Steps presented as an unordered list when order is required. Number them.
|
|
47
|
+
- Steps that bury the destructive action mid-list. Flag destructive steps with a clear warning.
|
|
48
|
+
- Steps that branch ("If X, do A; if Y, do B") without a labeled decision point. Use a decision header.
|
|
49
|
+
|
|
50
|
+
## Stock phrases to avoid
|
|
51
|
+
|
|
52
|
+
- "Should work"
|
|
53
|
+
- "Usually"
|
|
54
|
+
- "Most of the time"
|
|
55
|
+
- "Try"
|
|
56
|
+
- "It depends"
|
|
57
|
+
|
|
58
|
+
These are the language of guessing. Replace with conditions and exact commands.
|
|
59
|
+
|
|
60
|
+
## Closing pitfalls
|
|
61
|
+
|
|
62
|
+
- A "conclusion" section. Runbooks have no conclusion.
|
|
63
|
+
- A "thanks for reading" tone. The reader is mid-incident.
|
|
64
|
+
- A version stamp without a changelog. Date and reason for last revision belong at the top.
|