Skip to content

Commit 613c8c0

Browse files
aRustyDevclaude
andcommitted
docs(blog-workflow): add post type taxonomy documentation
Comprehensive taxonomy documentation covering: - 19 post types with definitions and usage guidance - Dimensions: formality (1-4), complexity (1-5), temporality, living docs - Relationships: series, project-arc, responds-to, supersedes, see-also - Series as first-class entity with independent metadata - Review subtypes: built-in (course, tool, library, book, policy) + custom - Workflow phases: idea → research → content → post → publish - Personas: practitioner and educator with voice/style guidelines - ADR-0002: Post Type Taxonomy Design decision record Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 41f467c commit 613c8c0

32 files changed

Lines changed: 4660 additions & 19 deletions

.github/pre-commit/words/project.txt

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,21 @@ crawl4ai
4141
crawlable
4242
cspell
4343
cupertino
44+
datasheet
4445
davepoon
46+
DDIA
47+
Dennard
48+
deprioritized
4549
devrag
4650
dsgvo
4751
DTCG
4852
Duplicat
4953
elec
5054
embeddings
5155
fastmcp
56+
FDTD
5257
ffuf
58+
Floorplan
5359
flowgpt
5460
FrancyJGLisboa
5561
getpid
@@ -67,9 +73,11 @@ henkisdabro
6773
hesreallyhim
6874
homoiconic
6975
homoiconicity
76+
Hyperdimensional
7077
iannuttall
7178
iconify
7279
Iconify
80+
Izhikevich
7381
Jeffallan
7482
jkitchin
7583
jqueryscript
@@ -89,30 +97,36 @@ mcpservers
8997
mcpxcodebuild
9098
meetrais
9199
Metaclasses
100+
microarchitectural
92101
mihaelamj
93102
modelcontextprotocol
94103
monorepo
95104
myproject
96105
neuromorphic
97106
nomic
107+
Nygard
98108
obra
99109
oldhash
100110
ollama
111+
opto
101112
orbstack
113+
overclaiming
102114
pargs
103115
pdate
104116
penpot
105-
precheck
106117
Penpot
107118
pentesting
119+
perfboard
108120
pinme
109121
pkgmgr
110122
polyrepo
111123
pproenca
124+
precheck
112125
productionization
113126
promptbase
114127
PRRT
115128
PRRTC
129+
Pryce
116130
punkpeye
117131
pybars
118132
PYBARS
@@ -132,18 +146,21 @@ Rxiv
132146
sandboxer
133147
secops
134148
semgrep
149+
SERP
135150
serper
136151
shellcheck
137152
shellharden
138153
shfmt
139154
simctl
140155
skillmd
141156
skillsmp
157+
slugified
142158
smithery
143159
sonnet
144160
sourcekit
145161
sqlfluff
146162
sqlite
163+
STDP
147164
subagent
148165
subviews
149166
Sundell
@@ -157,12 +174,15 @@ swiftui
157174
SwiftUI
158175
Tauri
159176
tenequm
177+
timebox
160178
tmppath
161179
tokei
162180
trafilatura
163181
trailofbits
164182
travisvn
165183
treesitter
184+
Trit
185+
underexplored
166186
underspecified
167187
unresolve
168188
Unresolve
@@ -189,24 +209,9 @@ XCUI
189209
xcuitest
190210
XCUITest
191211
xfurai
212+
Xplore
192213
yamadashy
193214
yamllint
194215
yara
195216
zeroize
196-
overclaiming
197-
Hyperdimensional
198-
Dennard
199-
Trit
200-
opto
201-
FDTD
202-
Floorplan
203-
microarchitectural
204-
underexplored
205217
Zotero
206-
Xplore
207-
datasheet
208-
perfboard
209-
deprioritized
210-
STDP
211-
Izhikevich
212-
SERP
Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,56 @@
11
# Summary
22

3-
- [Chapter 1](./chapter_1.md)
3+
[Introduction](./concepts.md)
4+
5+
## Taxonomy
6+
7+
- [Overview](./taxonomy/index.md)
8+
- [Post Types](./taxonomy/post/types.md)
9+
- [Dimensions](./taxonomy/dimensions.md)
10+
- [Formality](./taxonomy/dimensions.md#formality-spectrum)
11+
- [Complexity](./taxonomy/dimensions.md#complexity)
12+
- [Temporality](./taxonomy/dimensions.md#temporality)
13+
- [Living Documents](./taxonomy/dimensions.md#living-documents)
14+
- [Relationships](./taxonomy/relationships.md)
15+
- [Series](./taxonomy/series.md)
16+
- [Frontmatter Schema](./taxonomy/schema.md)
17+
18+
## Workflow
19+
20+
- [Concept](./workflow/concept.md)
21+
- [Project Lifecycle](./workflow/project-lifecycle.md)
22+
- [Choosing a Post Type](./workflow/choosing-type.md)
23+
- [Review Checklists](./workflow/review-checklists.md)
24+
- [Publishing Process](./workflow/publishing.md)
25+
26+
## Templates
27+
28+
- [Concept](./templates/concept.md)
29+
- [Outlines](./templates/outlines.md)
30+
- [Research Plans](./templates/research-plans.md)
31+
- [Review Checklists](./templates/review-checklists.md)
32+
33+
## Personas
34+
35+
- [Concept](./personas/concept.md)
36+
- [Practitioner](./personas/practitioner.md)
37+
- [Educator](./personas/educator.md)
38+
39+
## Reference
40+
41+
- [Frontmatter Reference](./reference/frontmatter.md)
42+
- [Command Reference](./reference/commands.md)
43+
- [Review Fields](./reference/review-fields.md)
44+
45+
## ADRs
46+
47+
- [Index](./adrs/index.md)
48+
49+
## Advanced
50+
51+
- [Skills](./skills/index.md)
52+
- [Agents](./agents/index.md)
53+
54+
---
55+
56+
[Troubleshooting](./TROUBLESHOOTING.md)

context/plugins/blog-workflow/docs/src/TROUBLESHOOTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,25 @@ Common issues and solutions for this plugin.
1515
### Issue: Plugin Installation Fails
1616

1717
**Symptoms:**
18+
1819
- Error during `just install-plugin`
1920
- Missing dependencies
2021

2122
**Solution:**
23+
2224
1. Ensure Homebrew is installed: `brew --version`
2325
2. Install plugin dependencies: `cd context/plugins/blog-workflow && brew bundle`
2426
3. Retry installation: `just install-plugin blog-workflow`
2527

2628
### Issue: MCP Server Connection Failed
2729

2830
**Symptoms:**
31+
2932
- "Cannot connect to MCP server" error
3033
- Timeout when using MCP-dependent features
3134

3235
**Solution:**
36+
3337
1. Check if server is running: `ps aux | grep <server-name>`
3438
2. Restart the server: `just restart-mcp blog-workflow`
3539
3. Check server logs for errors
@@ -38,10 +42,12 @@ Common issues and solutions for this plugin.
3842
### Issue: Command Returns Unexpected Results
3943

4044
**Symptoms:**
45+
4146
- Output doesn't match expectations
4247
- Missing data in response
4348

4449
**Solution:**
50+
4551
1. Check command arguments: `/<command> --help`
4652
2. Verify input format matches expected schema
4753
3. Check for recent changes in [CHANGELOG](../CHANGELOG.md)
@@ -91,6 +97,7 @@ If you can't resolve your issue:
9197
3. **Report a bug**: [Bug Report](https://github.com/aRustyDev/ai/issues/new?template=bug-report.yml)
9298

9399
When reporting, include:
100+
94101
- Plugin version (from `plugin.json`)
95102
- Steps to reproduce
96103
- Expected vs actual behavior
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# 1. Record architecture decisions
2+
3+
Date: 2026-03-16
4+
5+
## Status
6+
7+
Accepted
8+
9+
## Context
10+
11+
We need to record the architectural decisions made on this project.
12+
13+
## Decision
14+
15+
We will use Architecture Decision Records, as described by Michael Nygard in his article "Documenting Architecture Decisions".
16+
17+
## Consequences
18+
19+
See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's adr-tools.
Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# 2. Post Type Taxonomy Design
2+
3+
Date: 2026-03-16
4+
5+
## Status
6+
7+
Accepted
8+
9+
## Context
10+
11+
The blog-workflow plugin needed a systematic way to classify blog posts. Without clear post types, content becomes inconsistent in structure, voice, and reader expectations. Users asked questions like "what kind of post should this be?" without clear guidance.
12+
13+
Key requirements identified:
14+
15+
- Cover common technical blog content patterns
16+
- Distinguish by purpose, voice, and structure
17+
- Support progressive complexity (tutorials vs deep dives)
18+
- Handle temporal relationships (planning → retrospective)
19+
- Allow living documents vs static snapshots
20+
21+
## Decision
22+
23+
We adopt a **19-type taxonomy** organized across multiple dimensions:
24+
25+
### Post Types
26+
27+
1. **Tutorial** - Authoritative teaching
28+
2. **Walk-through** - Exploratory process documentation
29+
3. **Deep Dive** - Industry-oriented technical depth
30+
4. **Research** - Academic-style investigation
31+
5. **Study Review** - Learning reflection
32+
6. **Review** - External evaluation (with subtypes)
33+
7. **Comparison** - Side-by-side analysis
34+
8. **Problems** - Issue crystallization
35+
9. **Open Questions** - Possibility exploration
36+
10. **Planning** - Pre-work goal setting
37+
11. **Retrospective** - Post-work reflection
38+
12. **Updates** - Progress narrative
39+
13. **Opinions** - Personal perspective
40+
14. **Dev Blog** - Evergreen practitioner wisdom
41+
15. **Announcement** - Declaration
42+
16. **Reference** - Curated collection
43+
17. **ELI5** - Simplified explanation
44+
18. **5 Levels** - Progressive complexity explanation
45+
46+
### Dimensions
47+
48+
- **Formality** (1-4): Casual → Structured → Formal → Academic
49+
- **Complexity** (1-5): Accessible → Introductory → Intermediate → Advanced → Expert
50+
- **Temporality**: Before, During, After, Atemporal, Point-in-time
51+
- **Living**: Per-post toggle for maintained documents
52+
53+
### Relationships
54+
55+
Posts connect via explicit frontmatter relationships:
56+
57+
- `series` - Ordered sequence membership
58+
- `project-arc` - Planning → Updates → Retrospective
59+
- `responds-to` - Response to another post
60+
- `supersedes` / `superseded-by` - Replacement relationship
61+
- `see-also` - Curated related content
62+
63+
### Series as First-Class Entity
64+
65+
Series exist independently in `content/_series/` with their own metadata. Posts declare membership; the build system aggregates.
66+
67+
### Review Subtypes
68+
69+
Reviews use a hybrid approach:
70+
71+
- Built-in subtypes: course, tool, library, book, policy
72+
- Custom subtypes in `content/_templates/reviews/`
73+
- Universal fields + subtype-specific fields
74+
75+
## Consequences
76+
77+
### Easier
78+
79+
- **Choosing post type**: Decision tree guides selection
80+
- **Consistent structure**: Templates per type
81+
- **Reader expectations**: Clear type signals format
82+
- **Living documents**: Explicit support for maintained content
83+
- **Series navigation**: Built-in part ordering
84+
- **Content relationships**: Explicit linking between posts
85+
86+
### More Difficult
87+
88+
- **Learning curve**: 19 types + dimensions to understand
89+
- **Template maintenance**: More templates to maintain
90+
- **Edge cases**: Some content may not fit cleanly
91+
- **Validation complexity**: More fields to validate
92+
- **Migration**: Existing posts need type assignment
93+
94+
### Mitigations
95+
96+
- Decision tree and type guide documentation
97+
- Sensible defaults (formality: 2, complexity: 2)
98+
- Allow untyped posts during migration
99+
- Clear "when to use" guidance per type

0 commit comments

Comments
 (0)