← Back to list

tzurot-docs
by lbds137
A Discord bot that uses webhooks to represent multiple AI characters.
⭐ 7🍴 1📅 Jan 24, 2026
SKILL.md
name: tzurot-docs description: Contains MANDATORY documentation procedures. MUST be consulted at session end or when updating CURRENT_WORK.md. Covers folder structure and knowledge continuity. lastUpdated: '2026-01-21'
Tzurot v3 Documentation Maintenance
Use this skill when: Ending a session, completing a milestone, creating new documentation, or updating existing docs.
Quick Reference
# CURRENT_WORK.md format
> Last updated: YYYY-MM-DD
## Status: [Brief description of current focus]
**Current Phase**: [What you're actively working on]
**Recent Completion**: [Major milestone just finished]
## Active Work
[Details of current task]
## Planned Features (Priority Order)
[Upcoming work]
Core Documentation Files
| File | Purpose | Update When |
|---|---|---|
CURRENT_WORK.md | Active work status | Start/end session, milestone |
CLAUDE.md | Project guidelines | New patterns, conventions |
ROADMAP.md | Planning roadmap | Sprint changes |
| GitHub Releases | Version history | Each release |
Root files only: README.md, CLAUDE.md, CURRENT_WORK.md, ROADMAP.md. Everything else → docs/
Documentation Structure (Time-State Architecture)
docs/
├── reference/ # THE TRUTH - What currently exists
│ ├── architecture/ # Design decisions, system architecture
│ ├── deployment/ # Railway, infrastructure setup
│ ├── operations/ # Runbooks, backup procedures
│ ├── standards/ # Coding patterns, folder structure
│ ├── guides/ # Developer how-tos
│ ├── features/ # Feature documentation
│ ├── testing/ # Test procedures
│ ├── database/ # Schema documentation
│ └── templates/ # Reusable document templates
├── proposals/ # THE PLANS - What we want to build
│ ├── active/ # On roadmap, being worked on
│ └── backlog/ # Ideas not yet scheduled
├── incidents/ # Postmortems and lessons learned
└── migration/ # Active migration guides
Decision Rules
| Question | Answer |
|---|---|
| Is it implemented? | → reference/ |
| Is it a plan/idea? | → proposals/ (active or backlog) |
| Is it done/obsolete? | → Extract learnings, then DELETE |
| Is it an incident? | → incidents/ |
Proposal Lifecycle
- New idea →
proposals/backlog/ - Scheduled for work → Move to
proposals/active/ - Implementation complete:
- Extract learnings to
reference/docs or skills - Update incident docs if issues found
- DELETE the proposal (git preserves history)
- Extract learnings to
Session Handoff Protocol
At session end:
- Update CURRENT_WORK.md with progress
- Delete obsolete docs (git history preserves them)
- Update doc timestamps if modified
# Get current date
date +%Y-%m-%d
# Commit WIP if needed
git commit -m "wip: feature-name - progress description"
Best Practices
✅ Do
- Use descriptive names:
memory-and-context-redesign.md - Update existing docs instead of creating new ones
- Use YYYY-MM-DD date format
- Link between related docs with relative paths
- Delete obsolete docs (git preserves history)
- Use frontmatter for dates, not filenames
❌ Don't
- Create documentation bloat (one topic = one doc)
- Let CURRENT_WORK.md get stale
- Create README files in every directory
- Document obvious things
- Keep archive folders (delete instead)
- Put dates in filenames
Documentation Categories
| Type | Location | Purpose |
|---|---|---|
| Architecture decisions | docs/reference/architecture/ | Why we built it this way |
| Deployment guides | docs/reference/deployment/ | Railway setup, operations |
| Development guides | docs/reference/guides/ | How to do X |
| Coding standards | docs/reference/standards/ | Patterns to follow |
| Active proposals | docs/proposals/active/ | Currently being worked |
| Future ideas | docs/proposals/backlog/ | Not yet scheduled |
| Post-mortems | docs/incidents/ | Incident analysis |
GitHub Releases Format
## What's Changed
### Added
- New feature X for doing Y
### Changed
- Improved performance of A by 50%
### Fixed
- Bug where X would fail under Y conditions
**Full Changelog**: https://github.com/lbds137/tzurot/compare/vX.X.X...vY.Y.Y
Note: This project uses GitHub Releases, NOT CHANGELOG.md.
Anti-Patterns
| ❌ Don't | ✅ Do |
|---|---|
| Multiple docs for same topic | One comprehensive guide |
| Stale CURRENT_WORK.md | Update at session end |
| README in every directory | One main README |
| Document obvious things | Document non-obvious |
| Archive obsolete docs | Delete (extract learnings first) |
| Date-stamped filenames | Frontmatter dates |
Context Preservation
For AI sessions, always check these at session start:
- CURRENT_WORK.md - What's happening now?
- CLAUDE.md - What are the rules?
- docs/README.md - What docs exist?
Related Skills
- tzurot-git-workflow - Commit documentation updates
- tzurot-council-mcp - When to consult for doc structure
- tzurot-architecture - Document architectural decisions
References
- Documentation structure:
docs/README.md - Current project status:
CURRENT_WORK.md - Project guidelines:
CLAUDE.md - Tech debt tracking:
docs/proposals/active/TECH_DEBT.md
Score
Total Score
60/100
Based on repository quality metrics
✓SKILL.md
SKILL.mdファイルが含まれている
+20
✓LICENSE
ライセンスが設定されている
+10
○説明文
100文字以上の説明がある
0/10
○人気
GitHub Stars 100以上
0/15
○最近の活動
3ヶ月以内に更新がある
0/10
○フォーク
10回以上フォークされている
0/5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
○タグ
1つ以上のタグが設定されている
0/5
Reviews
💬
Reviews coming soon