reusable-solution-doc

Converts specific debugging experiences into generalized, reusable technical solution documents.

Updated May 28, 2026
One-click install
npx skills add https://github.com/changfengpro/agent-skills --skill reusable-solution-doc-changfengpro
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: reusable-solution-doc
Source: https://github.com/changfengpro/agent-skills/tree/main/skills/reusable-solution-doc
Command: npx skills add https://github.com/changfengpro/agent-skills --skill reusable-solution-doc-changfengpro

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? After fixing a concrete technical problem, engineers often want to preserve the lesson learned, but raw debugging notes are tied to specific project names, file paths, and libraries, making them useless to others. This Skill transforms a one-off troubleshooting experience into a de-projectized, portable reference document that any developer facing the same class of problem can follow. ## Core Features & Use Cases - De-specificization workflow: Systematically replaces concrete project names, file names, library names, and absolute paths with placeholders and category terms so the document stays portable. - Fixed document structure: Enforces a standard skeleton covering symptoms, root cause, numbered solution steps, verification checklist, maintenance notes, and rejected alternatives with reasons. - Style and boundary control: Applies a serious third-person technical tone, relative paths only, and explicit applicability boundaries (tool, platform, version constraints). - Use Case: After fixing a clangd indexing failure caused by build-generated headers in a nonstandard directory, produce a generic guide any developer with a similar generated-header setup can apply to their own project. ## Quick Start Turn the problem we just fixed into a generic reusable solution document without any specific project or file names, saved as a local Markdown file.

Frequently Asked Questions about reusable-solution-doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I turn a debugging session into a reusable technical document?

Abstract the specific problem into its general category: replace concrete file, library, and project names with placeholders, explain the root cause mechanism rather than the individual case, and structure the result as symptoms, root cause, numbered steps, verification checklist, and maintenance notes.

What is the difference between reusable-solution-doc and techdoc-writer?

reusable-solution-doc strips out real file, library, and platform names to produce a portable generic reference saved locally. techdoc-writer keeps real names, git diffs, and raw logs to produce a first-hand deliverable document, optionally published to Feishu.

How do I write technical documentation without exposing project-specific names?

Replace concrete names with category terms and placeholders: a generated header becomes 'build-time generated header', an absolute path becomes ${workspaceFolder}/<build directory>. Then search the full text for project names, usernames, and machine names to confirm nothing remains.

What structure should a general troubleshooting guide follow?

Use this order: title with applicability metadata, observable symptoms, root cause mechanism with a comparison table for parallel causes, numbered solution steps with commands, a verification checklist, maintenance notes, optional remarks, and rejected alternatives with explicit reasons.

When should I not use a generalized solution document?

Do not generalize when the deliverable must preserve first-hand evidence such as git diffs, raw logs, or real platform names, for example a bring-up record or an official-style manual. In those cases use a project-specific documentation skill instead.