flonat-research 0.1.0
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/.claude/agents/domain-reviewer.md +336 -0
- package/.claude/agents/fixer.md +226 -0
- package/.claude/agents/paper-critic.md +370 -0
- package/.claude/agents/peer-reviewer.md +289 -0
- package/.claude/agents/proposal-reviewer.md +215 -0
- package/.claude/agents/referee2-reviewer.md +367 -0
- package/.claude/agents/references/journal-referee-profiles.md +354 -0
- package/.claude/agents/references/paper-critic/council-personas.md +77 -0
- package/.claude/agents/references/paper-critic/council-prompts.md +198 -0
- package/.claude/agents/references/peer-reviewer/report-template.md +199 -0
- package/.claude/agents/references/peer-reviewer/sa-prompts.md +260 -0
- package/.claude/agents/references/peer-reviewer/security-scan.md +188 -0
- package/.claude/agents/references/proposal-reviewer/report-template.md +144 -0
- package/.claude/agents/references/proposal-reviewer/sa-prompts.md +149 -0
- package/.claude/agents/references/referee-config.md +114 -0
- package/.claude/agents/references/referee2-reviewer/audit-checklists.md +287 -0
- package/.claude/agents/references/referee2-reviewer/report-template.md +334 -0
- package/.claude/rules/design-before-results.md +52 -0
- package/.claude/rules/ignore-agents-md.md +17 -0
- package/.claude/rules/ignore-gemini-md.md +17 -0
- package/.claude/rules/lean-claude-md.md +45 -0
- package/.claude/rules/learn-tags.md +99 -0
- package/.claude/rules/overleaf-separation.md +67 -0
- package/.claude/rules/plan-first.md +175 -0
- package/.claude/rules/read-docs-first.md +50 -0
- package/.claude/rules/scope-discipline.md +28 -0
- package/.claude/settings.json +125 -0
- package/.context/current-focus.md +33 -0
- package/.context/preferences/priorities.md +36 -0
- package/.context/preferences/task-naming.md +28 -0
- package/.context/profile.md +29 -0
- package/.context/projects/_index.md +41 -0
- package/.context/projects/papers/nudge-exp.md +22 -0
- package/.context/projects/papers/uncertainty.md +31 -0
- package/.context/resources/claude-scientific-writer-review.md +48 -0
- package/.context/resources/cunningham-multi-analyst-agents.md +104 -0
- package/.context/resources/cunningham-multilang-code-audit.md +62 -0
- package/.context/resources/google-ai-co-scientist-review.md +72 -0
- package/.context/resources/karpathy-llm-council-review.md +58 -0
- package/.context/resources/multi-coder-reliability-protocol.md +175 -0
- package/.context/resources/pedro-santanna-takeaways.md +96 -0
- package/.context/resources/venue-rankings/abs_ajg_2024.csv +1823 -0
- package/.context/resources/venue-rankings/abs_ajg_2024_econ.csv +356 -0
- package/.context/resources/venue-rankings/cabs_4_4star_theory.csv +40 -0
- package/.context/resources/venue-rankings/core_2026.csv +801 -0
- package/.context/resources/venue-rankings.md +147 -0
- package/.context/workflows/README.md +69 -0
- package/.context/workflows/daily-review.md +91 -0
- package/.context/workflows/meeting-actions.md +108 -0
- package/.context/workflows/replication-protocol.md +155 -0
- package/.context/workflows/weekly-review.md +113 -0
- package/.mcp-server-biblio/formatters.py +158 -0
- package/.mcp-server-biblio/pyproject.toml +11 -0
- package/.mcp-server-biblio/server.py +678 -0
- package/.mcp-server-biblio/sources/__init__.py +14 -0
- package/.mcp-server-biblio/sources/base.py +73 -0
- package/.mcp-server-biblio/sources/formatters.py +83 -0
- package/.mcp-server-biblio/sources/models.py +22 -0
- package/.mcp-server-biblio/sources/multi_source.py +243 -0
- package/.mcp-server-biblio/sources/openalex_source.py +183 -0
- package/.mcp-server-biblio/sources/scopus_source.py +309 -0
- package/.mcp-server-biblio/sources/wos_source.py +508 -0
- package/.mcp-server-biblio/uv.lock +896 -0
- package/.scripts/README.md +161 -0
- package/.scripts/ai_pattern_density.py +446 -0
- package/.scripts/conf +445 -0
- package/.scripts/config.py +122 -0
- package/.scripts/count_inventory.py +275 -0
- package/.scripts/daily_digest.py +288 -0
- package/.scripts/done +177 -0
- package/.scripts/extract_meeting_actions.py +223 -0
- package/.scripts/focus +176 -0
- package/.scripts/generate-codex-agents-md.py +217 -0
- package/.scripts/inbox +194 -0
- package/.scripts/notion_helpers.py +325 -0
- package/.scripts/openalex/query_helpers.py +306 -0
- package/.scripts/papers +227 -0
- package/.scripts/query +223 -0
- package/.scripts/session-history.py +201 -0
- package/.scripts/skill-health.py +516 -0
- package/.scripts/skill-log-miner.py +273 -0
- package/.scripts/sync-to-codex.sh +252 -0
- package/.scripts/task +213 -0
- package/.scripts/tasks +190 -0
- package/.scripts/week +206 -0
- package/CLAUDE.md +197 -0
- package/LICENSE +21 -0
- package/MEMORY.md +38 -0
- package/README.md +269 -0
- package/docs/agents.md +44 -0
- package/docs/bibliography-setup.md +55 -0
- package/docs/council-mode.md +36 -0
- package/docs/getting-started.md +245 -0
- package/docs/hooks.md +38 -0
- package/docs/mcp-servers.md +82 -0
- package/docs/notion-setup.md +109 -0
- package/docs/rules.md +33 -0
- package/docs/scripts.md +303 -0
- package/docs/setup-overview/setup-overview.pdf +0 -0
- package/docs/skills.md +70 -0
- package/docs/system.md +159 -0
- package/hooks/block-destructive-git.sh +66 -0
- package/hooks/context-monitor.py +114 -0
- package/hooks/postcompact-restore.py +157 -0
- package/hooks/precompact-autosave.py +181 -0
- package/hooks/promise-checker.sh +124 -0
- package/hooks/protect-source-files.sh +81 -0
- package/hooks/resume-context-loader.sh +53 -0
- package/hooks/startup-context-loader.sh +102 -0
- package/package.json +51 -0
- package/packages/cli-council/.github/workflows/claude-code-review.yml +44 -0
- package/packages/cli-council/.github/workflows/claude.yml +50 -0
- package/packages/cli-council/README.md +100 -0
- package/packages/cli-council/pyproject.toml +43 -0
- package/packages/cli-council/src/cli_council/__init__.py +19 -0
- package/packages/cli-council/src/cli_council/__main__.py +185 -0
- package/packages/cli-council/src/cli_council/backends/__init__.py +8 -0
- package/packages/cli-council/src/cli_council/backends/base.py +81 -0
- package/packages/cli-council/src/cli_council/backends/claude.py +25 -0
- package/packages/cli-council/src/cli_council/backends/codex.py +27 -0
- package/packages/cli-council/src/cli_council/backends/gemini.py +26 -0
- package/packages/cli-council/src/cli_council/checkpoint.py +212 -0
- package/packages/cli-council/src/cli_council/config.py +51 -0
- package/packages/cli-council/src/cli_council/council.py +391 -0
- package/packages/cli-council/src/cli_council/models.py +46 -0
- package/packages/llm-council/.github/workflows/claude-code-review.yml +44 -0
- package/packages/llm-council/.github/workflows/claude.yml +50 -0
- package/packages/llm-council/README.md +453 -0
- package/packages/llm-council/pyproject.toml +42 -0
- package/packages/llm-council/src/llm_council/__init__.py +23 -0
- package/packages/llm-council/src/llm_council/__main__.py +259 -0
- package/packages/llm-council/src/llm_council/checkpoint.py +193 -0
- package/packages/llm-council/src/llm_council/client.py +253 -0
- package/packages/llm-council/src/llm_council/config.py +232 -0
- package/packages/llm-council/src/llm_council/council.py +482 -0
- package/packages/llm-council/src/llm_council/models.py +46 -0
- package/packages/mcp-bibliography/MEMORY.md +31 -0
- package/packages/mcp-bibliography/_app.py +226 -0
- package/packages/mcp-bibliography/formatters.py +158 -0
- package/packages/mcp-bibliography/log/2026-03-13-2100.md +35 -0
- package/packages/mcp-bibliography/pyproject.toml +15 -0
- package/packages/mcp-bibliography/run.sh +20 -0
- package/packages/mcp-bibliography/scholarly_formatters.py +83 -0
- package/packages/mcp-bibliography/server.py +1857 -0
- package/packages/mcp-bibliography/tools/__init__.py +28 -0
- package/packages/mcp-bibliography/tools/_registry.py +19 -0
- package/packages/mcp-bibliography/tools/altmetric.py +107 -0
- package/packages/mcp-bibliography/tools/core.py +92 -0
- package/packages/mcp-bibliography/tools/dblp.py +52 -0
- package/packages/mcp-bibliography/tools/openalex.py +296 -0
- package/packages/mcp-bibliography/tools/opencitations.py +102 -0
- package/packages/mcp-bibliography/tools/openreview.py +179 -0
- package/packages/mcp-bibliography/tools/orcid.py +131 -0
- package/packages/mcp-bibliography/tools/scholarly.py +575 -0
- package/packages/mcp-bibliography/tools/unpaywall.py +63 -0
- package/packages/mcp-bibliography/tools/zenodo.py +123 -0
- package/packages/mcp-bibliography/uv.lock +711 -0
- package/scripts/setup.sh +143 -0
- package/skills/beamer-deck/SKILL.md +199 -0
- package/skills/beamer-deck/references/quality-rubric.md +54 -0
- package/skills/beamer-deck/references/review-prompts.md +106 -0
- package/skills/bib-validate/SKILL.md +261 -0
- package/skills/bib-validate/references/council-mode.md +34 -0
- package/skills/bib-validate/references/deep-verify.md +79 -0
- package/skills/bib-validate/references/fix-mode.md +36 -0
- package/skills/bib-validate/references/openalex-verification.md +45 -0
- package/skills/bib-validate/references/preprint-check.md +31 -0
- package/skills/bib-validate/references/ref-manager-crossref.md +41 -0
- package/skills/bib-validate/references/report-template.md +82 -0
- package/skills/code-archaeology/SKILL.md +141 -0
- package/skills/code-review/SKILL.md +265 -0
- package/skills/code-review/references/quality-rubric.md +67 -0
- package/skills/consolidate-memory/SKILL.md +208 -0
- package/skills/context-status/SKILL.md +126 -0
- package/skills/creation-guard/SKILL.md +230 -0
- package/skills/devils-advocate/SKILL.md +130 -0
- package/skills/devils-advocate/references/competing-hypotheses.md +83 -0
- package/skills/init-project/SKILL.md +115 -0
- package/skills/init-project-course/references/memory-and-settings.md +92 -0
- package/skills/init-project-course/references/organise-templates.md +94 -0
- package/skills/init-project-course/skill.md +147 -0
- package/skills/init-project-light/skill.md +139 -0
- package/skills/init-project-research/SKILL.md +368 -0
- package/skills/init-project-research/references/atlas-pipeline-sync.md +70 -0
- package/skills/init-project-research/references/atlas-schema.md +81 -0
- package/skills/init-project-research/references/confirmation-report.md +39 -0
- package/skills/init-project-research/references/domain-profile-template.md +104 -0
- package/skills/init-project-research/references/interview-round3.md +34 -0
- package/skills/init-project-research/references/literature-discovery.md +43 -0
- package/skills/init-project-research/references/scaffold-details.md +197 -0
- package/skills/init-project-research/templates/field-calibration.md +60 -0
- package/skills/init-project-research/templates/pipeline-manifest.md +63 -0
- package/skills/init-project-research/templates/run-all.sh +116 -0
- package/skills/init-project-research/templates/seed-files.md +337 -0
- package/skills/insights-deck/SKILL.md +151 -0
- package/skills/interview-me/SKILL.md +157 -0
- package/skills/latex/SKILL.md +141 -0
- package/skills/latex/references/latex-configs.md +183 -0
- package/skills/latex-autofix/SKILL.md +230 -0
- package/skills/latex-autofix/references/known-errors.md +183 -0
- package/skills/latex-autofix/references/quality-rubric.md +50 -0
- package/skills/latex-health-check/SKILL.md +161 -0
- package/skills/learn/SKILL.md +220 -0
- package/skills/learn/scripts/validate_skill.py +265 -0
- package/skills/lessons-learned/SKILL.md +201 -0
- package/skills/literature/SKILL.md +335 -0
- package/skills/literature/references/agent-templates.md +393 -0
- package/skills/literature/references/bibliometric-apis.md +44 -0
- package/skills/literature/references/cli-council-search.md +79 -0
- package/skills/literature/references/openalex-api-guide.md +371 -0
- package/skills/literature/references/openalex-common-queries.md +381 -0
- package/skills/literature/references/openalex-workflows.md +248 -0
- package/skills/literature/references/reference-manager-sync.md +36 -0
- package/skills/literature/references/scopus-api-guide.md +208 -0
- package/skills/literature/references/wos-api-guide.md +308 -0
- package/skills/multi-perspective/SKILL.md +311 -0
- package/skills/multi-perspective/references/computational-many-analysts.md +77 -0
- package/skills/pipeline-manifest/SKILL.md +226 -0
- package/skills/pre-submission-report/SKILL.md +153 -0
- package/skills/process-reviews/SKILL.md +244 -0
- package/skills/process-reviews/references/rr-routing.md +101 -0
- package/skills/project-deck/SKILL.md +87 -0
- package/skills/project-safety/SKILL.md +135 -0
- package/skills/proofread/SKILL.md +254 -0
- package/skills/proofread/references/quality-rubric.md +104 -0
- package/skills/python-env/SKILL.md +57 -0
- package/skills/quarto-deck/SKILL.md +226 -0
- package/skills/quarto-deck/references/markdown-format.md +143 -0
- package/skills/quarto-deck/references/quality-rubric.md +54 -0
- package/skills/save-context/SKILL.md +174 -0
- package/skills/session-log/SKILL.md +98 -0
- package/skills/shared/concept-validation-gate.md +161 -0
- package/skills/shared/council-protocol.md +265 -0
- package/skills/shared/distribution-diagnostics.md +164 -0
- package/skills/shared/engagement-stratified-sampling.md +218 -0
- package/skills/shared/escalation-protocol.md +74 -0
- package/skills/shared/external-audit-protocol.md +205 -0
- package/skills/shared/intercoder-reliability.md +256 -0
- package/skills/shared/mcp-degradation.md +81 -0
- package/skills/shared/method-probing-questions.md +163 -0
- package/skills/shared/multi-language-conventions.md +143 -0
- package/skills/shared/paid-api-safety.md +174 -0
- package/skills/shared/palettes.md +90 -0
- package/skills/shared/progressive-disclosure.md +92 -0
- package/skills/shared/project-documentation-content.md +443 -0
- package/skills/shared/project-documentation-format.md +281 -0
- package/skills/shared/project-documentation.md +100 -0
- package/skills/shared/publication-output.md +138 -0
- package/skills/shared/quality-scoring.md +70 -0
- package/skills/shared/reference-resolution.md +77 -0
- package/skills/shared/research-quality-rubric.md +165 -0
- package/skills/shared/rhetoric-principles.md +54 -0
- package/skills/shared/skill-design-patterns.md +272 -0
- package/skills/shared/skill-index.md +240 -0
- package/skills/shared/system-documentation.md +334 -0
- package/skills/shared/tikz-rules.md +402 -0
- package/skills/shared/validation-tiers.md +121 -0
- package/skills/shared/venue-guides/README.md +46 -0
- package/skills/shared/venue-guides/cell_press_style.md +483 -0
- package/skills/shared/venue-guides/conferences_formatting.md +564 -0
- package/skills/shared/venue-guides/cs_conference_style.md +463 -0
- package/skills/shared/venue-guides/examples/cell_summary_example.md +247 -0
- package/skills/shared/venue-guides/examples/medical_structured_abstract.md +313 -0
- package/skills/shared/venue-guides/examples/nature_abstract_examples.md +213 -0
- package/skills/shared/venue-guides/examples/neurips_introduction_example.md +245 -0
- package/skills/shared/venue-guides/journals_formatting.md +486 -0
- package/skills/shared/venue-guides/medical_journal_styles.md +535 -0
- package/skills/shared/venue-guides/ml_conference_style.md +556 -0
- package/skills/shared/venue-guides/nature_science_style.md +405 -0
- package/skills/shared/venue-guides/reviewer_expectations.md +417 -0
- package/skills/shared/venue-guides/venue_writing_styles.md +321 -0
- package/skills/split-pdf/SKILL.md +172 -0
- package/skills/split-pdf/methodology.md +48 -0
- package/skills/sync-notion/SKILL.md +93 -0
- package/skills/system-audit/SKILL.md +157 -0
- package/skills/system-audit/references/sub-agent-prompts.md +294 -0
- package/skills/task-management/SKILL.md +131 -0
- package/skills/update-focus/SKILL.md +204 -0
- package/skills/update-project-doc/SKILL.md +194 -0
- package/skills/validate-bib/SKILL.md +242 -0
- package/skills/validate-bib/references/council-mode.md +34 -0
- package/skills/validate-bib/references/deep-verify.md +71 -0
- package/skills/validate-bib/references/openalex-verification.md +45 -0
- package/skills/validate-bib/references/preprint-check.md +31 -0
- package/skills/validate-bib/references/report-template.md +62 -0
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
# Skill Index
|
|
2
|
+
|
|
3
|
+
> Compact discovery table for all skills. Scan this when checking for duplicates,
|
|
4
|
+
> answering "what skills do I have for X?", or deciding where a new skill fits.
|
|
5
|
+
|
|
6
|
+
## By Category
|
|
7
|
+
|
|
8
|
+
### Ideation (3)
|
|
9
|
+
|
|
10
|
+
| Skill | Purpose |
|
|
11
|
+
|-------|---------|
|
|
12
|
+
| `interview-me` | Interactive interview to formalise a research idea into a structured spec |
|
|
13
|
+
| `devils-advocate` | Multi-turn debate to challenge assumptions and stress-test arguments |
|
|
14
|
+
| `multi-perspective` | Parallel agents with distinct disciplinary lenses explore a question |
|
|
15
|
+
| `scout-audit` | Batch novelty checks with venue and idea iteration |
|
|
16
|
+
| `scout-discover` | Topic discovery and idea generation via Scout CLI |
|
|
17
|
+
| `scout-evaluate` | Novelty scoring and idea ranking via Scout CLI |
|
|
18
|
+
| `scout-develop` | Iterative idea development and Lopez-Lira refinement via Scout CLI |
|
|
19
|
+
| `scout-position` | Venue suggestion, framing, and acceptance assessment via Scout CLI |
|
|
20
|
+
| `atlas-coherence` | Map portfolio as a network: clusters, bridges, orphans, sequencing |
|
|
21
|
+
| `atlas-novelty` | Score atlas topics by novelty via batch Scout checks |
|
|
22
|
+
| `interdisciplinary-bridge` | Import concepts from adjacent fields to solve open problems |
|
|
23
|
+
| `future-research-agenda` | Generate provocative, fundable future research directions |
|
|
24
|
+
|
|
25
|
+
### Literature (9)
|
|
26
|
+
|
|
27
|
+
| Skill | Purpose |
|
|
28
|
+
|-------|---------|
|
|
29
|
+
| `literature` | Academic search, citation verification, .bib management, OpenAlex API |
|
|
30
|
+
| `split-pdf` | Deep-read papers via 4-page chunks with structured notes |
|
|
31
|
+
| `gather-readings` | Copy PDFs from Zotero into project articles/ folder |
|
|
32
|
+
| `theory-mapper` | Map theoretical landscape across a corpus of papers |
|
|
33
|
+
| `method-audit` | Compare data collection methods and spot biases |
|
|
34
|
+
| `evolution-timeline` | Chronological narrative of field evolution |
|
|
35
|
+
| `quote-mining` | Extract exact quotes with page numbers and argument mapping |
|
|
36
|
+
| `weakness-scanner` | Find weakest arguments and logical flaws across a literature |
|
|
37
|
+
| `replication-audit` | Audit replication status of key findings |
|
|
38
|
+
|
|
39
|
+
### Writing (1)
|
|
40
|
+
|
|
41
|
+
| Skill | Purpose |
|
|
42
|
+
|-------|---------|
|
|
43
|
+
| `proofread` | 7-category LaTeX proofreading scorecard (report only) |
|
|
44
|
+
| `claim-audit` | Verify cited claims against actual source papers |
|
|
45
|
+
| `voice-analyzer` | Analyze writing samples to create a portable voice profile (VOICE.md) |
|
|
46
|
+
| `voice-editor` | Edit content to match a voice profile (6-pass workflow, 4 editing modes) |
|
|
47
|
+
| `journal-voice` | Extract journal writing patterns and conventions into JOURNAL-VOICE.md |
|
|
48
|
+
| `review-response` | Systematic reviewer response drafting with classification, strategy, and tone checks |
|
|
49
|
+
|
|
50
|
+
### Presentation (8)
|
|
51
|
+
|
|
52
|
+
| Skill | Purpose |
|
|
53
|
+
|-------|---------|
|
|
54
|
+
| `beamer-deck` | Rhetoric-driven Beamer slides with multi-agent review |
|
|
55
|
+
| `quarto-deck` | Reveal.js HTML presentations (teaching, informal talks) |
|
|
56
|
+
| `quarto-course` | Quarto course websites with slides and exercises |
|
|
57
|
+
| `project-deck` | Status decks for supervisor meetings and handoffs |
|
|
58
|
+
| `insights-deck` | Claude Code usage insights as a Beamer presentation |
|
|
59
|
+
| `latex-posters` | Research posters in LaTeX (beamerposter, tikzposter, baposter) |
|
|
60
|
+
| `translate-to-quarto` | Translate Beamer LaTeX slides to Quarto RevealJS |
|
|
61
|
+
| `pptx` | Create, read, edit, or manipulate PowerPoint files |
|
|
62
|
+
|
|
63
|
+
### LaTeX & Bibliography (10)
|
|
64
|
+
|
|
65
|
+
| Skill | Purpose |
|
|
66
|
+
|-------|---------|
|
|
67
|
+
| `latex` | Basic LaTeX compilation with latexmk |
|
|
68
|
+
| `latex-autofix` | **Default compiler** — auto-fixes errors, citation audit on success |
|
|
69
|
+
| `latex-health-check` | Compile all projects, auto-fix, check cross-project consistency |
|
|
70
|
+
| `latex-template` | Compare preamble against working paper template (report + apply) |
|
|
71
|
+
| `bib-validate` | Cross-reference \cite{} keys against .bib files (report only) |
|
|
72
|
+
| `bib-filter` | Filter a .bib file to only entries actually cited in a .tex project |
|
|
73
|
+
| `bib-parse` | Extract citations from a PDF and generate a validated `.bib` file |
|
|
74
|
+
| `bib-coverage` | Compare a project .bib against a Zotero collection to find uncited papers |
|
|
75
|
+
| `bib-migrate` | Compare Paperpile and Zotero libraries to find items missing from each |
|
|
76
|
+
| `latex-scaffold` | Convert Markdown draft into buildable LaTeX project (md→tex) |
|
|
77
|
+
|
|
78
|
+
### Submission (5)
|
|
79
|
+
|
|
80
|
+
| Skill | Purpose |
|
|
81
|
+
|-------|---------|
|
|
82
|
+
| `pre-submission-report` | All quality checks in one dated report |
|
|
83
|
+
| `retarget-journal` | Switch paper to different journal (rename, reformat, rekey) |
|
|
84
|
+
| `process-reviews` | Referee comments PDF into tracking files |
|
|
85
|
+
| `synthesise-reviews` | Synthesise parallel review reports into a prioritised revision plan |
|
|
86
|
+
| `brief-compliance-check` | Check LaTeX submission against assessment brief (deliverables, word limits, required files) |
|
|
87
|
+
|
|
88
|
+
### Project Setup & Session (17)
|
|
89
|
+
|
|
90
|
+
| Skill | Purpose |
|
|
91
|
+
|-------|---------|
|
|
92
|
+
| `init-project-research` | Full project scaffold (interview, git, Overleaf, vault) |
|
|
93
|
+
| `init-project-course` | Course/module folder scaffold |
|
|
94
|
+
| `init-project-light` | Lightweight scaffold (CLAUDE.md only, no git/vault) |
|
|
95
|
+
| `init-project-orchestration` | Add project agents, commands, and planning to a research project |
|
|
96
|
+
| `project-safety` | Safety rules and folder structures to prevent data loss |
|
|
97
|
+
| `session-log` | Timestamped progress logs for session continuity |
|
|
98
|
+
| `general-session-recap` | End-of-session checklist for any project type |
|
|
99
|
+
| `research-session-recap` | Research session close with atlas/vault checks |
|
|
100
|
+
| `update-focus` | Structured update to current-focus.md |
|
|
101
|
+
| `context-status` | On-demand session health check |
|
|
102
|
+
| `save-context` | Save information to context library files |
|
|
103
|
+
| `task-management` | Daily planning, weekly reviews, meeting actions, vault |
|
|
104
|
+
| `ideas` | Capture improvement ideas for the infrastructure |
|
|
105
|
+
| `consolidate-memory` | Prune, merge, and abstract MEMORY.md entries |
|
|
106
|
+
| `update-project-doc` | Update a project's own docs to reflect current state |
|
|
107
|
+
| `vault sync` | Sync project state to context library and vault |
|
|
108
|
+
| `email-digest` | Email digest from Gmail |
|
|
109
|
+
| `decision-toolkit` | Structured decision-making for methodology, venue, or framework choices |
|
|
110
|
+
|
|
111
|
+
### Code & Analysis (8)
|
|
112
|
+
|
|
113
|
+
| Skill | Purpose |
|
|
114
|
+
|-------|---------|
|
|
115
|
+
| `code-review` | 11-category scorecard for R/Python scripts (report only) |
|
|
116
|
+
| `code-archaeology` | Review and document old code, data, and analysis files |
|
|
117
|
+
| `pipeline-manifest` | Map scripts to inputs, outputs, and paper figures/tables |
|
|
118
|
+
| `python-env` | Python environment management (enforces uv) |
|
|
119
|
+
| `audit-project-research` | Audit project against init-project-research template |
|
|
120
|
+
| `audit-project-course` | Audit course folder against init-project-course template |
|
|
121
|
+
| `webapp-testing` | Playwright-based web app testing with server lifecycle management. *From Anthropic.* |
|
|
122
|
+
| `frontend-design` | Distinctive, production-grade frontend interfaces. *From Anthropic.* |
|
|
123
|
+
|
|
124
|
+
### Experimental & Data (11)
|
|
125
|
+
|
|
126
|
+
| Skill | Purpose |
|
|
127
|
+
|-------|---------|
|
|
128
|
+
| `data-analysis` | End-to-end analysis pipeline (EDA, estimation, publication output) across R/Python/Stata/Julia |
|
|
129
|
+
| `computational-experiments` | Scaffold, run, and publish computational research experiments (algorithm skeletons, config-driven sweeps, seed-deterministic runners, publication figures) |
|
|
130
|
+
| `experiment-design` | Experimental and survey design: power analysis, PAP, QSF parsing, survey construction |
|
|
131
|
+
| `causal-design` | Identification strategy design and audit (DiD/IV/RDD/SC/event study) |
|
|
132
|
+
| `synthetic-data` | Generate structurally realistic synthetic datasets for pilot testing and power analysis |
|
|
133
|
+
| `replication-package` | Replication package assembly, anonymization, and audit (replaces export-project-clean/anon) |
|
|
134
|
+
| `econ-data` | Fetch economic data from FRED, World Bank, Eurostat, ECB, OECD, and EEX APIs |
|
|
135
|
+
| `econ-plots` | Economics-standard ggplot2 plots: coefficient, binscatter, RDD, decomposition |
|
|
136
|
+
| `r-econometrics` | R regression and econometrics: OLS, IV, panel, RDD, robust SEs |
|
|
137
|
+
| `event-studies` | DiD and event study implementation in R (TWFE vs modern estimators) |
|
|
138
|
+
| `code-paper-audit` | Systematic 6-phase code-paper consistency audit |
|
|
139
|
+
|
|
140
|
+
### Infrastructure (30)
|
|
141
|
+
|
|
142
|
+
| Skill | Purpose |
|
|
143
|
+
|-------|---------|
|
|
144
|
+
| `learn` | Extract session knowledge into a new persistent skill |
|
|
145
|
+
| `creation-guard` | Pre-flight duplicate check before creating new skills/agents |
|
|
146
|
+
| `lessons-learned` | Structured post-mortem for incidents and stuck sessions |
|
|
147
|
+
| `system-audit` | Parallel audits across skills, hooks, agents, rules, docs |
|
|
148
|
+
| `atlas-review` | Full audit of all topics across 4 systems |
|
|
149
|
+
| `atlas-deploy` | Compile atlas.json from topic files, commit, and deploy atlas web app to Fly.io |
|
|
150
|
+
| `rename-project-research` | Rename an Atlas topic slug across all systems |
|
|
151
|
+
| `sync-atlas` | Sync between Atlas topic files and vault |
|
|
152
|
+
| `atlas-drift-check` | Verify Atlas schema, vault sync, disk paths, and frontmatter consistency |
|
|
153
|
+
| `scout-drift-check` | Check CLI-web parity, route coverage, and taxonomy consistency in Scout |
|
|
154
|
+
| `sync-repo` | Sync docs with system state for atlas, scout, refpile, or private repos |
|
|
155
|
+
| `sync-public-repo` | Sync private infrastructure to the public repo (claude-research) |
|
|
156
|
+
| `sync-public-review` | Interactive review and editing of public sync allowlists |
|
|
157
|
+
| `sync-santi-repo` | Regenerate the santi-repo starter kit from private rules |
|
|
158
|
+
| `sync-resources` | Pull latest from cloned resource repos |
|
|
159
|
+
| `sync-permissions` | Sync global permissions into projects |
|
|
160
|
+
| `full-commit` | Commit and push all 8 global repos with leak guard |
|
|
161
|
+
| `publish` | Full publication pipeline: sync, bump, commit, tag, publish |
|
|
162
|
+
| `refpile-development` | Update and manage RefPile development topic documents |
|
|
163
|
+
| `skill-creator` | Create, iterate, and benchmark skills with eval viewer. *From Anthropic.* |
|
|
164
|
+
| `skill-health` | Skill health dashboard: invocation counts, success rates, health status |
|
|
165
|
+
| `mcp-builder` | Guide for creating MCP servers (Python/FastMCP or TypeScript). *From Anthropic.* |
|
|
166
|
+
| `external-audit` | External LLM audit of any repo (atlas, scout, refpile, private, public, santi) |
|
|
167
|
+
| `audit-doc` | Documentation quality audit for any repo (atlas, scout, refpile, private, public, santi) |
|
|
168
|
+
| `docs-review` | Cross-cutting doc review: count consistency, component coverage, stale refs, public-private sync, user manual |
|
|
169
|
+
| `machine-audit` | Audit machine environment (Homebrew, dotfiles, credentials, dev tools, nested repos, MCP) |
|
|
170
|
+
| `machine-review` | Holistic review of machine setup from snapshots: missing tools, redundant apps, cross-machine parity |
|
|
171
|
+
| `radar` | Search the web for Claude Code updates, AI workflow patterns, and MCP ecosystem news |
|
|
172
|
+
| `radar-integrate` | Convert saved radar tips into infrastructure changes |
|
|
173
|
+
| `wire-shared-package` | Wire a shared Python package as an editable dependency across projects |
|
|
174
|
+
|
|
175
|
+
### Document Formats (3)
|
|
176
|
+
|
|
177
|
+
| Skill | Purpose |
|
|
178
|
+
|-------|---------|
|
|
179
|
+
| `docx` | Create, read, edit, or manipulate Word documents |
|
|
180
|
+
| `pdf` | Read, extract, combine, split, rotate, watermark PDF files |
|
|
181
|
+
| `xlsx` | Create, read, edit spreadsheets (.xlsx, .csv, .tsv) |
|
|
182
|
+
|
|
183
|
+
### Meetings (11)
|
|
184
|
+
|
|
185
|
+
| Skill | Purpose |
|
|
186
|
+
|-------|---------|
|
|
187
|
+
| `minutes-record` | Start or stop recording a meeting, call, or voice memo |
|
|
188
|
+
| `minutes-debrief` | Post-meeting debrief — compare outcomes to prep intentions |
|
|
189
|
+
| `minutes-prep` | Interactive meeting preparation with relationship briefs |
|
|
190
|
+
| `minutes-recap` | Daily digest of meetings — decisions, action items, themes |
|
|
191
|
+
| `minutes-weekly` | Weekly meeting synthesis — themes, decision arcs, stale commitments |
|
|
192
|
+
| `minutes-search` | Search past meeting transcripts and voice memos |
|
|
193
|
+
| `minutes-list` | List recent meetings and voice memos |
|
|
194
|
+
| `minutes-note` | Add timestamped notes during or after a recording |
|
|
195
|
+
| `minutes-verify` | Verify minutes setup — model, mic, directories |
|
|
196
|
+
| `minutes-setup` | Guided first-time setup for minutes |
|
|
197
|
+
| `minutes-cleanup` | Manage old recordings — archive, delete, disk space |
|
|
198
|
+
|
|
199
|
+
---
|
|
200
|
+
|
|
201
|
+
**Total: 139 skills across 12 categories.**
|
|
202
|
+
|
|
203
|
+
---
|
|
204
|
+
|
|
205
|
+
## Shared References (not skills — cross-cutting protocols)
|
|
206
|
+
|
|
207
|
+
Files in `skills/shared/` that multiple skills and agents reference. These are not invocable skills — they are guidance documents read on demand.
|
|
208
|
+
|
|
209
|
+
### Methodological Protocols
|
|
210
|
+
|
|
211
|
+
| File | Purpose | Used by |
|
|
212
|
+
|------|---------|---------|
|
|
213
|
+
| `escalation-protocol.md` | 4-level methodological pushback (Probe → Explain → Challenge → Flag) | paper-critic, referee2-reviewer, domain-reviewer, data-analysis, causal-design, experiment-design |
|
|
214
|
+
| `method-probing-questions.md` | Mandatory pre-analysis questions by method (12 paradigms) | data-analysis, causal-design, experiment-design, referee2-reviewer, domain-reviewer |
|
|
215
|
+
| `distribution-diagnostics.md` | DV distribution checks + model selection decision tree | data-analysis, referee2-reviewer, domain-reviewer |
|
|
216
|
+
| `engagement-stratified-sampling.md` | Engagement-tier sampling for social media data | data-analysis, experiment-design, referee2-reviewer |
|
|
217
|
+
| `intercoder-reliability.md` | Per-category reliability + LLM annotation validation | data-analysis, experiment-design, referee2-reviewer, domain-reviewer |
|
|
218
|
+
|
|
219
|
+
### Skill Architecture
|
|
220
|
+
|
|
221
|
+
| File | Purpose |
|
|
222
|
+
|------|---------|
|
|
223
|
+
| `quality-scoring.md` | Shared scoring framework for quality reports |
|
|
224
|
+
| `progressive-disclosure.md` | Pattern for splitting large skills into core + references |
|
|
225
|
+
| `skill-design-patterns.md` | Structural patterns for skill architecture |
|
|
226
|
+
| `rhetoric-principles.md` | Presentation rhetoric for deck skills |
|
|
227
|
+
| `multi-language-conventions.md` | R/Python/Stata/Julia conventions for analysis skills |
|
|
228
|
+
| `reference-resolution.md` | Logic for resolving Zotero collections and topic references |
|
|
229
|
+
| `research-quality-rubric.md` | Research quality rubric for review agents |
|
|
230
|
+
| `council-protocol.md` | Multi-model council deliberation protocol |
|
|
231
|
+
| `external-audit-protocol.md` | Protocol for external LLM audits |
|
|
232
|
+
| `paid-api-safety.md` | Cost guardrails for paid API calls |
|
|
233
|
+
| `mcp-degradation.md` | Graceful degradation when MCP tools are unavailable |
|
|
234
|
+
| `project-documentation.md` | Project documentation conventions (index) |
|
|
235
|
+
| `project-documentation-content.md` | Content conventions (README, manual, architecture, deploy) |
|
|
236
|
+
| `project-documentation-format.md` | Format conventions (ASCII, LaTeX, Beamer, public variants) |
|
|
237
|
+
| `system-documentation.md` | System documentation conventions |
|
|
238
|
+
| `tikz-rules.md` | TikZ diagram conventions |
|
|
239
|
+
| `palettes.md` | Colour palettes for visualisations |
|
|
240
|
+
| `skill-index.md` | This file |
|
|
@@ -0,0 +1,334 @@
|
|
|
1
|
+
# System Documentation Conventions
|
|
2
|
+
|
|
3
|
+
> Formatting, structure, and style conventions for Task Management infrastructure documentation: CLAUDE.md, SKILL.md, rules, component catalogues (`docs/`), and shared resources.
|
|
4
|
+
>
|
|
5
|
+
> Companion to `project-documentation.md` (which covers outward-facing docs like READMEs, user manuals, and architecture references).
|
|
6
|
+
|
|
7
|
+
## Document Types and Purposes
|
|
8
|
+
|
|
9
|
+
| Document | Audience | Purpose | Tone |
|
|
10
|
+
|----------|----------|---------|------|
|
|
11
|
+
| `CLAUDE.md` | Claude (AI) | Session instructions — what to do and how | Imperative, terse |
|
|
12
|
+
| `README.md` | Human developers | Project overview, quick start, navigation | Friendly, scannable |
|
|
13
|
+
| `SKILL.md` | Claude (AI) | Step-by-step workflow protocol | Imperative, procedural |
|
|
14
|
+
| `docs/*.md` | Human + AI | Detailed reference material | Neutral, thorough |
|
|
15
|
+
| `user-manual.md` | End users | Feature docs, how-to guides | Approachable, example-driven |
|
|
16
|
+
| `architecture.md` | Maintainers | Technical internals, data flow, design decisions | Precise, factual |
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Markdown Formatting
|
|
21
|
+
|
|
22
|
+
### Header Hierarchy
|
|
23
|
+
|
|
24
|
+
```markdown
|
|
25
|
+
# Document Title ← one per file, matches the file's purpose
|
|
26
|
+
## Major Section ← top-level topic divisions
|
|
27
|
+
### Subsection ← details within a section
|
|
28
|
+
#### Rarely deeper ← only for deeply nested reference material
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Never skip levels (e.g., `#` → `###`). Use `##` as the primary structural unit — most navigation (TOCs, anchors, `/help` slugs) keys off `##` headings.
|
|
32
|
+
|
|
33
|
+
### Opening Context Block
|
|
34
|
+
|
|
35
|
+
Every document starts with a title, then a blockquote summarising what the file is and who it's for:
|
|
36
|
+
|
|
37
|
+
```markdown
|
|
38
|
+
# Document Title
|
|
39
|
+
|
|
40
|
+
> One-liner explaining what this document covers and when to read it.
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
For reference files shared across skills, add a second line noting which skills consume it:
|
|
44
|
+
|
|
45
|
+
```markdown
|
|
46
|
+
> Shared reference for `/skill-a`, `/skill-b`, and `/skill-c`.
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Tables
|
|
50
|
+
|
|
51
|
+
Use tables for structured reference material — indices, mappings, rubrics, configuration:
|
|
52
|
+
|
|
53
|
+
```markdown
|
|
54
|
+
| Column A | Column B | Column C |
|
|
55
|
+
|----------|----------|----------|
|
|
56
|
+
| value | value | value |
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
- Left-align text columns, right-align numeric columns
|
|
60
|
+
- Bold header-row values only when the table is a rubric or decision matrix
|
|
61
|
+
- Prefer tables over bullet lists when items have 2+ parallel attributes
|
|
62
|
+
- Keep cell content concise — one line per cell, no paragraphs inside cells
|
|
63
|
+
|
|
64
|
+
### Code Blocks
|
|
65
|
+
|
|
66
|
+
Always use fenced code blocks with language tags:
|
|
67
|
+
|
|
68
|
+
````markdown
|
|
69
|
+
```python
|
|
70
|
+
def example():
|
|
71
|
+
pass
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
uv run python script.py
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
```latex
|
|
79
|
+
\section{Introduction}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
```yaml
|
|
83
|
+
name: skill-name
|
|
84
|
+
description: "What it does"
|
|
85
|
+
```
|
|
86
|
+
````
|
|
87
|
+
|
|
88
|
+
For inline code: use backticks for file names (`` `config.py` ``), class names (`` `Settings` ``), method names (`` `discover_topics()` ``), env vars (`` `OPENROUTER_API_KEY` ``), and CLI commands (`` `uv run python` ``).
|
|
89
|
+
|
|
90
|
+
### Lists
|
|
91
|
+
|
|
92
|
+
- **Numbered lists** for sequential steps (protocols, workflows, order of operations)
|
|
93
|
+
- **Bullet lists** for non-sequential items (features, alternatives, notes)
|
|
94
|
+
- **Nested bullets** for elaboration — one level deep only; if deeper nesting is needed, restructure as a subsection
|
|
95
|
+
- **Checklists** (`- [ ]`) only in plans and session logs, never in reference docs
|
|
96
|
+
|
|
97
|
+
### Cross-References
|
|
98
|
+
|
|
99
|
+
```markdown
|
|
100
|
+
Full details: [`docs/architecture.md`](docs/architecture.md)
|
|
101
|
+
See [`references/drift-checks.md`](references/drift-checks.md)
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
Always use relative paths. Always include both the display text (the file name) and the link. For skills, use the forward-slash notation: `/skill-name`.
|
|
105
|
+
|
|
106
|
+
### Horizontal Rules
|
|
107
|
+
|
|
108
|
+
Use `---` to separate major conceptual blocks within a section. Do not use between every subsection — only between distinct topics or phases.
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## Document Structure Patterns
|
|
113
|
+
|
|
114
|
+
### CLAUDE.md (AI Context File)
|
|
115
|
+
|
|
116
|
+
```markdown
|
|
117
|
+
# Claude Context for [Project Name]
|
|
118
|
+
|
|
119
|
+
> One-liner about the project.
|
|
120
|
+
|
|
121
|
+
## [Safety/Protection Rules] ← always first if present
|
|
122
|
+
## File Structure ← compact tree, annotated
|
|
123
|
+
## Conventions ← project-specific rules
|
|
124
|
+
## [Domain-Specific Sections] ← what Claude needs to know
|
|
125
|
+
## Session Continuity ← pointers to .context/, log/
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
**Key constraints:**
|
|
129
|
+
- **Max 200 lines.** Extract anything longer than 15 lines of reference material to `docs/` with a one-line pointer (see `lean-claude-md` rule).
|
|
130
|
+
- **Instructions, not knowledge.** CLAUDE.md tells Claude what to do and where to look — it doesn't store the knowledge itself.
|
|
131
|
+
- **Pointer pattern:** `Full guidelines: [\`docs/file.md\`](docs/file.md)`
|
|
132
|
+
|
|
133
|
+
### README.md (Human Overview)
|
|
134
|
+
|
|
135
|
+
```markdown
|
|
136
|
+
# Project Name
|
|
137
|
+
|
|
138
|
+
Brief description (1-3 sentences).
|
|
139
|
+
|
|
140
|
+
## What It Does / Overview ← the "why" and "what"
|
|
141
|
+
## Getting Started / Setup ← quick start for new users
|
|
142
|
+
## Project Structure ← compact file tree
|
|
143
|
+
## Documentation ← links to docs/ files
|
|
144
|
+
## [Key Sections] ← project-specific
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
**Key constraints:**
|
|
148
|
+
- **Max 150 lines** for most projects (300 for the Task Management root).
|
|
149
|
+
- Overlap with `user-manual.md` or `docs/` should be a summary + link, not duplication.
|
|
150
|
+
- Quick start instructions must be copy-pasteable.
|
|
151
|
+
|
|
152
|
+
### SKILL.md (Workflow Protocol)
|
|
153
|
+
|
|
154
|
+
```yaml
|
|
155
|
+
---
|
|
156
|
+
name: skill-name
|
|
157
|
+
description: "One-line description of what the skill does."
|
|
158
|
+
allowed-tools: Read, Edit, Write, Glob, Grep, Bash(pattern*), AskUserQuestion
|
|
159
|
+
argument-hint: <topic> [--flag]
|
|
160
|
+
---
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
```markdown
|
|
164
|
+
# Skill Title
|
|
165
|
+
|
|
166
|
+
> Audit sentence explaining what this skill does and when to use it.
|
|
167
|
+
|
|
168
|
+
## When to Use
|
|
169
|
+
## When NOT to Use
|
|
170
|
+
## Protocol ← numbered steps
|
|
171
|
+
### Step 1: [Action]
|
|
172
|
+
### Step 2: [Action]
|
|
173
|
+
## [Reference Tables]
|
|
174
|
+
## Cross-References ← links to related skills
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
**Key constraints:**
|
|
178
|
+
- **Max 300 lines.** Extract long reference tables, rubrics, or examples to `references/` with a pointer.
|
|
179
|
+
- Steps are imperative: "Read the file", "Compare against", "Flag mismatches".
|
|
180
|
+
- Include a `When NOT to Use` section to prevent misapplication.
|
|
181
|
+
|
|
182
|
+
### Docs Files (Reference Material)
|
|
183
|
+
|
|
184
|
+
No strict template — structure follows the content. But follow these conventions:
|
|
185
|
+
|
|
186
|
+
- Start with `# Title` + blockquote context
|
|
187
|
+
- Use `##` sections as the main structural unit
|
|
188
|
+
- Include a navigation aid for long files (table of contents or section index at the top)
|
|
189
|
+
- Architecture docs should include ASCII diagrams for data flow and system overview
|
|
190
|
+
- API/configuration docs should use tables for parameter lists
|
|
191
|
+
|
|
192
|
+
### Component Catalogues (`docs/skills.md`, `docs/hooks.md`, etc.)
|
|
193
|
+
|
|
194
|
+
The Task Management `docs/` folder uses a consistent pattern for documenting collections of infrastructure components (skills, hooks, agents, rules, resources, scripts).
|
|
195
|
+
|
|
196
|
+
```markdown
|
|
197
|
+
# Component Type (plural)
|
|
198
|
+
|
|
199
|
+
> {count} {component type} + one-sentence description of what they are.
|
|
200
|
+
|
|
201
|
+
Brief intro paragraph: what the component is, where it lives, how it's configured.
|
|
202
|
+
|
|
203
|
+
## Overview
|
|
204
|
+
|
|
205
|
+
| Component | Category | Description |
|
|
206
|
+
|-----------|----------|-------------|
|
|
207
|
+
| `name` | ... | ... |
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
|
|
211
|
+
## Component Details
|
|
212
|
+
|
|
213
|
+
### 1. Component Name (optional metadata)
|
|
214
|
+
|
|
215
|
+
What it does, when it applies, and how it works.
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
**Conventions:**
|
|
219
|
+
- **Count in blockquote:** Every catalogue opens with the actual count. This count must match reality — `/sync-repo private` propagates count changes across files.
|
|
220
|
+
- **Overview table first:** A compact table listing every item before any details. Columns vary by component type (see below).
|
|
221
|
+
- **Numbered detail sections:** Each component gets a `###` subsection.
|
|
222
|
+
- **Cross-file count consistency:** Counts appear in CLAUDE.md, README.md, `docs/system.md`, and the catalogue file. All must agree.
|
|
223
|
+
|
|
224
|
+
**Catalogue-specific columns:**
|
|
225
|
+
|
|
226
|
+
| Catalogue | Required columns |
|
|
227
|
+
|-----------|-----------------|
|
|
228
|
+
| Skills (`docs/skills.md`) | Skill, Category, Description |
|
|
229
|
+
| Hooks (`docs/hooks.md`) | Hook, Event, Matcher, Script, What it does |
|
|
230
|
+
| Agents (`docs/agents.md`) | Agent, Purpose |
|
|
231
|
+
| Rules (`docs/rules.md`) | Rule, File, What it does |
|
|
232
|
+
| Resources (`docs/resources.md`) | Category, Author, Repo, What it provides |
|
|
233
|
+
|
|
234
|
+
### System Overview (`docs/system.md`)
|
|
235
|
+
|
|
236
|
+
Not a component catalogue but an architectural overview of the entire Task Management system. Uses:
|
|
237
|
+
|
|
238
|
+
- ASCII diagram showing the full system layout
|
|
239
|
+
- Numbered `##` sections for each major subsystem (context library, skills, hooks, etc.)
|
|
240
|
+
- Component count references that stay in sync with the individual catalogues
|
|
241
|
+
- File structure table mapping paths to purposes
|
|
242
|
+
|
|
243
|
+
---
|
|
244
|
+
|
|
245
|
+
## Writing Conventions
|
|
246
|
+
|
|
247
|
+
### Voice and Tone
|
|
248
|
+
|
|
249
|
+
| Context | Voice | Example |
|
|
250
|
+
|---------|-------|---------|
|
|
251
|
+
| CLAUDE.md, SKILL.md, rules | Imperative | "Read the config file. Compare against the source." |
|
|
252
|
+
| README.md, user-manual | Second person | "You can configure the model with `--model`." |
|
|
253
|
+
| Architecture docs | Third person, present tense | "The orchestrator wires the data source to the LLM service." |
|
|
254
|
+
| Session logs | Past tense, first person plural | "We implemented the validation script." |
|
|
255
|
+
|
|
256
|
+
### Conciseness
|
|
257
|
+
|
|
258
|
+
- Lead with the information, not the setup. Not "It should be noted that X" — just "X".
|
|
259
|
+
- One idea per paragraph. If a paragraph covers two distinct points, split it.
|
|
260
|
+
- Prefer tables over prose for structured information (3+ items with parallel attributes).
|
|
261
|
+
- Delete filler: "basically", "simply", "just", "in order to", "it is important to note that".
|
|
262
|
+
|
|
263
|
+
### Terminology
|
|
264
|
+
|
|
265
|
+
Use these terms consistently across all documentation:
|
|
266
|
+
|
|
267
|
+
| Term | Meaning | Not |
|
|
268
|
+
|------|---------|-----|
|
|
269
|
+
| Skill | Reusable workflow definition in `skills/` | "command", "script", "macro" |
|
|
270
|
+
| Agent | Independent Claude instance with fresh context | "sub-agent", "worker" |
|
|
271
|
+
| Hook | Automated script triggered by Claude Code events | "trigger", "listener" |
|
|
272
|
+
| Rule | Behavioural constraint, auto-loaded every session | "policy", "guideline" |
|
|
273
|
+
| Resource | Cloned external repo in `resources/` | "dependency", "library" |
|
|
274
|
+
| Workflow | A sequence of steps within a skill | "process", "pipeline" (unless actually a data pipeline) |
|
|
275
|
+
| Drift | Documentation claiming something that code no longer supports | "stale", "outdated" (less precise) |
|
|
276
|
+
|
|
277
|
+
### Numbers and Counts
|
|
278
|
+
|
|
279
|
+
- Spell out numbers one through nine in prose; use digits for 10+.
|
|
280
|
+
- Always verify counts by listing actual files — never trust cached numbers in docs.
|
|
281
|
+
- When a count appears in multiple files, update all of them (or use `/sync-repo private`).
|
|
282
|
+
|
|
283
|
+
### File Paths
|
|
284
|
+
|
|
285
|
+
- Use backtick-quoted relative paths: `` `src/services/llm.py` ``
|
|
286
|
+
- In file trees, use the standard tree notation:
|
|
287
|
+
|
|
288
|
+
```
|
|
289
|
+
project/
|
|
290
|
+
├── src/
|
|
291
|
+
│ ├── main.py
|
|
292
|
+
│ └── config.py
|
|
293
|
+
├── docs/
|
|
294
|
+
│ └── architecture.md
|
|
295
|
+
└── README.md
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
- Annotate tree entries with brief descriptions when the name isn't self-explanatory:
|
|
299
|
+
|
|
300
|
+
```
|
|
301
|
+
├── bootstrap.py # Shared init logic — used by CLI + web
|
|
302
|
+
├── config.py # Settings + re-exports from llm-council
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
---
|
|
306
|
+
|
|
307
|
+
## Anti-Patterns
|
|
308
|
+
|
|
309
|
+
| Anti-Pattern | Why It's Bad | Fix |
|
|
310
|
+
|--------------|-------------|-----|
|
|
311
|
+
| Duplicating content across files | Goes stale independently, contradicts itself | Keep detail in one file, use pointers elsewhere |
|
|
312
|
+
| Hardcoding counts in prose | Requires manual updates across 8+ files | Use verifiable counts or link to the source |
|
|
313
|
+
| Writing CLAUDE.md as a knowledge base | Burns tokens every session | Extract to `docs/`, leave a one-line pointer |
|
|
314
|
+
| Paragraphs inside table cells | Unreadable, breaks rendering | Keep cells to one line; use a subsection instead |
|
|
315
|
+
| Deep nesting (4+ bullet levels) | Cognitive overload, hard to scan | Restructure as subsections or a table |
|
|
316
|
+
| Mixing imperative and descriptive voice | Confusing — is this an instruction or a description? | Match voice to document type (see table above) |
|
|
317
|
+
| Undated session-specific content in reference docs | Reference docs should be timeless | Session details go in `log/`, not `docs/` |
|
|
318
|
+
|
|
319
|
+
---
|
|
320
|
+
|
|
321
|
+
## Checklist for New Documents
|
|
322
|
+
|
|
323
|
+
Before considering a document complete:
|
|
324
|
+
|
|
325
|
+
1. **Opening context block** — title + blockquote describing purpose and audience
|
|
326
|
+
2. **Header hierarchy** — no skipped levels, `##` as primary structure
|
|
327
|
+
3. **Tables for structured data** — not bullet-list parades
|
|
328
|
+
4. **Code blocks tagged** — every fenced block has a language identifier
|
|
329
|
+
5. **Cross-references linked** — related files and skills linked, not just named
|
|
330
|
+
6. **Within line limits** — CLAUDE.md < 200, README < 150, SKILL.md < 300
|
|
331
|
+
7. **No duplication** — information lives in one canonical place with pointers
|
|
332
|
+
8. **Terminology matches** — uses standard terms from the terminology table
|
|
333
|
+
9. **Voice matches document type** — imperative for instructions, descriptive for reference
|
|
334
|
+
10. **File paths are relative** — no absolute paths in documentation
|