Generate FAQ Entry
Follow these steps to generate a new FAQ entry.
Step 1: Load Context
- •Read
.claude/feedback/patterns.mdfor proven patterns and anti-patterns. - •Read
templates/faq-template.mdfor the canonical structure. - •Read
marketing/brand/style-guide.mdfor voice and tone guidance.
Step 2: Check for Duplicates
Use Glob to scan knowledge/faq/ for existing FAQ entries. Use Grep to search for similar questions or topics. Alert the user if a duplicate or closely related FAQ already exists and suggest updating the existing entry instead.
Step 3: Gather Required Context
Ask the user for the following information (use [PLACEHOLDER] for anything not provided):
- •Topic — Category or subject area (e.g., Benefits, IT, Onboarding, Consulting)
- •Question — The exact question as a user would ask it
- •Short Answer — One to two sentence summary answer
- •Detailed Answer — Full explanation with context, steps, or examples
- •Related Articles — Links to other FAQ entries or knowledge articles
- •Audience — Who typically asks this question (employees, clients, consultants)
Step 4: Generate the FAQ Entry
Using the template structure, generate the FAQ entry with these sections:
- •Question — Clear, natural-language question.
- •Short Answer — Concise answer (1-2 sentences) suitable for quick reference or search snippets.
- •Detailed Answer — Full explanation including:
- •Context or background
- •Step-by-step instructions if applicable
- •Examples or scenarios
- •Edge cases or exceptions
- •Related Articles — Bulleted list of links to related FAQ entries or knowledge articles.
- •Last Verified — Date the answer was last confirmed accurate.
- •Contact — Who to reach out to if the answer does not resolve the question.
Include full YAML frontmatter:
yaml
--- title: "[Question]" type: faq status: draft author: "[PLACEHOLDER]" created: "YYYY-MM-DD" topic: "[PLACEHOLDER]" audience: "[employees|clients|consultants|all]" last-verified: "YYYY-MM-DD" next-review: "YYYY-MM-DD" tags: - faq - [topic] ---
Step 5: Write the File
Write the file to:
code
knowledge/faq/[topic]-[question-slug].md
Use lowercase-hyphens for the filename. Create intermediate directories if needed.
Step 6: Log the Action
Append a JSON line to .claude/feedback/skills-log.jsonl:
json
{"skill": "new-faq", "file": "<output-path>", "timestamp": "<ISO-8601>", "status": "created"}