workthrough_skill

Overview

This skill automatically documents all development work and code modifications in a structured workthrough format. It generates clear, consistent records after any task, bug fix, refactor, or configuration change. The output is formatted for readability and stored under a workthrough/ directory with timestamped or descriptive filenames.

How this skill works

After a development session, the skill gathers modified files, relevant build and test outputs, and developer-provided context. It composes a workthrough document with sections for title, overview, context, changes made, code examples, and verification results. The document is saved to workthrough/YYYY-MM-DD-brief-description.md or a feature/bugfix subfolder and includes before/after snippets and verification logs.

When to use it

• After implementing new features or functionality
• When fixing bugs or regressions
• Following code refactors or architecture changes
• After configuration or dependency updates
• When resolving build, CI, or compilation issues

Best practices

• Capture the complete context: problem, prior state, and rationale for decisions
• List every modified file with full paths and describe exact changes
• Include before/after code snippets for significant edits and highlight key lines
• Attach build and test outputs, exit codes, and any remaining errors
• Use clear, concise language and standard formatting so other developers can quickly understand the work

Example use cases

• Documenting a new API endpoint implementation with files changed, sample requests, and test results
• Recording a bugfix that required code and config updates, including reproduction steps and verification logs
• Describing a refactor that moved components or modules with before/after code snippets and dependency notes
• Logging an upgrade of a library or build tool with configuration changes and CI build output
• Creating onboarding material for a feature by combining context, code examples, and verification