Documenting Legacy Codebases
by riekelt85e53729dd95No license28 starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 3 weeks ago
Use when documenting an existing codebase whose documentation is missing, stale, or untrusted - an inherited system, a legacy application, a repo where the docs lie - or when regrounding a documentation tree against the code, or when someone asks what a system actually does. Encodes the survey-first inventory, the writer-side evidence hierarchy, depth-per-surface rules, the refactor test, dead-or-alive proofs, the quirks-and-findings split, the coverage ledger, the parallel campaign, and the docs-tree skeleton. Use whenever documentation must be reconstructed from the code rather than written alongside a change.
Only the file list is public. File contents are available once the skill is installed in a workspace.
| Path | Size | Type |
|---|---|---|
| SKILL.md | 14.8 KB | text/markdown |
Source and attribution
Source:riekelt/technical-writerinplugins/technical-writer/skills/documenting-legacy-codebasesat commit85e5372
License: No license
Content belongs to its original authors. SourceWeft indexes it from a public repository.
More from riekelt/technical-writer
Writing Runbooks
riekelt
Guides writing of runbooks, setup, release, migration and deprecation procedures that someone will execute under time pressure.
Writing Postmortems
riekelt
Guides writing blameless postmortems, incident reports, and root-cause analyses with evidence-based timelines and owned action items.
Writing Issues
riekelt
Guides writing tracker issues such as epics, stories, tasks, bugs and spikes with testable acceptance criteria.
Writing Design Docs
riekelt
Guides writing proposals, RFCs, design docs, specs and migration plans with a fixed skeleton and completeness checks.
Writing Changelogs
riekelt
Guides writing changelog entries, release notes and handover summaries with fixed entry shapes and honesty conventions.
Technical Writing
riekelt
House style and truth rules for drafting, restructuring, and revising technical documents such as specs, design docs, and READMEs.
More in Software Development
Playground
anthropics
Builds self-contained interactive HTML playgrounds with controls, live preview, and copyable prompt output.
M5 Onboard
anthropics
Provisions M5Stack ESP32 boards by detecting them on USB, flashing UIFlow 2.0 firmware, and installing a MicroPython app bundle.
Cardputer Buddy
anthropics
Guides iterating on a Cardputer-Adv MicroPython app bundle: adding apps, pushing files over USB-serial, tailing logs, and running REPL commands.
Web Design Guidelines
vercel-labs
Reviews UI code against Web Interface Guidelines fetched from a remote source and reports findings as file:line entries.
Vercel React Native Skills
vercel-labs
React Native and Expo best-practice rules covering list performance, animation, navigation, UI patterns, state, and monorepo setup.
Vercel React Best Practices
vercel-labs
Vercel's React and Next.js performance guidelines, organized as 70 rules for writing, reviewing, and refactoring code.