Knowledge Base Capture
Workflow
- Identify audience, knowledge type, source material, owner, and intended knowledge base location if provided.
- Extract reusable knowledge: purpose, prerequisites, steps, decisions, troubleshooting, examples, and limits.
- Remove transient discussion, duplicated context, and unresolved claims unless they are marked for review.
- Structure the article for reuse, searchability, ownership, and future maintenance.
- Produce a clean KB draft with metadata and review questions.
Script-Assisted Workflow
When reviewing a markdown KB draft, run scripts/check_kb_metadata.py --input <draft.md> to check required sections, metadata completeness, review freshness, owner gaps, and unresolved assumptions. Adjust --required-sections and --today for the target knowledge-base standard. Use the output to decide publishing readiness; do not use the script to rewrite the article.
Output Standard
Use this structure by default:
- Title: searchable, specific, and outcome-oriented.
- Audience: who should use the article.
- Summary: what the article helps the reader do.
- Prerequisites: access, tools, context, or permissions needed.
- Procedure / Guidance: steps, decision rules, or reference content.
- Troubleshooting / Exceptions: known issues, limits, and escalation path.
- Ownership And Freshness: owner, review date, source, and confidence.
- Related Links: source artifacts or related docs when provided.
- Review Questions: unresolved items before publishing.
Rules
- Do not publish unresolved assumptions as facts.
- Preserve source provenance when available.
- Flag stale, sensitive, incomplete, or ownerless knowledge for review.
- Make the article useful to someone who was not present for the original discussion.
References
Read references/kb-patterns.md when the user asks for SOPs, troubleshooting articles, incident learnings, onboarding docs, or support knowledge.
1---2name: knowledge-base-capture3description: Convert meetings, support threads, incident learnings, project notes, SOP drafts, process explanations, or expert knowledge into clean knowledge-base articles with audience, steps, ownership, freshness metadata, related links, and review needs. Use when Codex needs to preserve institutional knowledge in a reusable article.4---56# Knowledge Base Capture78## Workflow9101. Identify audience, knowledge type, source material, owner, and intended knowledge base location if provided.112. Extract reusable knowledge: purpose, prerequisites, steps, decisions, troubleshooting, examples, and limits.123. Remove transient discussion, duplicated context, and unresolved claims unless they are marked for review.134. Structure the article for reuse, searchability, ownership, and future maintenance.145. Produce a clean KB draft with metadata and review questions.1516## Script-Assisted Workflow1718When reviewing a markdown KB draft, run `scripts/check_kb_metadata.py --input <draft.md>` to check required sections, metadata completeness, review freshness, owner gaps, and unresolved assumptions. Adjust `--required-sections` and `--today` for the target knowledge-base standard. Use the output to decide publishing readiness; do not use the script to rewrite the article.1920## Output Standard2122Use this structure by default:2324- **Title**: searchable, specific, and outcome-oriented.25- **Audience**: who should use the article.26- **Summary**: what the article helps the reader do.27- **Prerequisites**: access, tools, context, or permissions needed.28- **Procedure / Guidance**: steps, decision rules, or reference content.29- **Troubleshooting / Exceptions**: known issues, limits, and escalation path.30- **Ownership And Freshness**: owner, review date, source, and confidence.31- **Related Links**: source artifacts or related docs when provided.32- **Review Questions**: unresolved items before publishing.3334## Rules3536- Do not publish unresolved assumptions as facts.37- Preserve source provenance when available.38- Flag stale, sensitive, incomplete, or ownerless knowledge for review.39- Make the article useful to someone who was not present for the original discussion.4041## References4243Read `references/kb-patterns.md` when the user asks for SOPs, troubleshooting articles, incident learnings, onboarding docs, or support knowledge.
ClarentCinematics