project-faqlisted

Create a detailed, self-contained FAQ or question-and-answer wiki for a software project as a single tabbed HTML page with a grouped sidebar, deep links, and keyboard navigation. Every answer is multi-paragraph and carries two worked examples (one real from the project, one everyday analogy). Use this whenever the user wants an FAQ, Q&A page, knowledge base, help centre, project wiki, "common questions", or a page that answers "how does my project do X and why" for newcomers and teammates. Use it even if the user only says "make a page that answers questions about my project", "turn my notes into an FAQ", or "explain the decisions and the workflow for new joiners". Not a concepts course (learning-track), not the design-rationale doc (architecture-and-decisions), not a single-task how-to (usage-guide), not contributor onboarding (onboarding-companion). Includes a reusable Python generator so the HTML structure stays clean.
imrohitagrawal/project-doc-skills · ★ 0 · AI & Automation · score 58

Install: claude install-skill imrohitagrawal/project-doc-skills

# Project FAQ / Q&A Wiki Builder Build a **detailed FAQ** as one self-contained tabbed HTML file. The reader is a newcomer or a teammate — a fresh graduate, a class-12 student, or a new joiner — who must come away able to (a) say what the project is and why it matters, (b) set the tools up, (c) run it end to end, and (d) describe how the pieces fit. Read `references/house-style.md` first, every time. **Diátaxis mode:** a hybrid of *how-to* and *reference*, answering real questions in depth. The FAQ is usually team-facing (`scope_project_faq` defaults to `internal`), so it **may** name the day-to-day workflow and tools — unlike a public learning track. (`verify.py --skill project-faq` resolves `scope_project_faq` and `grade_target_project_faq` from the profile.) --- ## Before you start (inputs, when to run, where it sits) **Inputs it needs.** A populated repository to answer *from* — at least a README, the decision records / decision log, the stack list, the day-to-day workflow and config files, the setup steps, and any security/operations notes — plus the project profile (`assets/project-profile.md`, copied to `docs/project-profile.md`). The FAQ surveys these; it does not invent answers. If a needed fact is missing, say so rather than fabricate it. **When to run it in a Claude-Code build.** *Not* on an empty repo, and *not* per commit. The FAQ is a milestone artifact: run it once there is enough built and decided to answer real questions — in practice after the architec