Codexqa Requirement Analyzer logo

Codexqa Requirement Analyzer

Organization
openqa-cn
codexqa-requirement-analyzer

Full quality-and-risk analysis of requirement documents (single- or multi-source), producing one gap/conflict register with executable P0/P1 verification. Triggers: requirements analyzer, requirement quality, gap register, 需求分析, 需求分析器, 需求评审, 需求缺口. Not for writing a case library (that is codexqa-testcase-generator), constructing test data (codexqa-testdata-generator), or reviewing code (codexqa-defect-analyzer / codexqa-code-reviewer). Former skill name: requirements-analyzer.

Overview

Publisheropenqa-cn
Repositorycodexqa
Skill namecodexqa-requirement-analyzer
Stars
233
Forks
3
Bundled files
64
LicenseApache-2.0
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 64 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by openqa-cn on GitHub. Read the source before you install it.

Installation

Install the Codexqa Requirement Analyzer AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/openqa-cn/codexqa/tree/main/skills/codexqa-requirement-analyzer
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/openqa-cn/codexqa.git /tmp/codexqa
mkdir -p .claude/skills
cp -r /tmp/codexqa/skills/codexqa-requirement-analyzer .claude/skills/codexqa-requirement-analyzer
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Codexqa Requirement Analyzer in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Codexqa Requirement Analyzer on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Codexqa Requirement Analyzer is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Requirements Analyzer

Human-facing install and method docs: README.md, HOW_IT_WORKS.md, KNOWN_LIMITATIONS.md (and .zh-CN.md). Do not load those at runtime.

When to Use

  • Need a complete quality and risk analysis of requirement documents, not just a scope scan or a gap list.
  • Materials may be a single PRD or a multi-source pack (stories, APIs, plans, role reports).
  • Need one reviewable, assignable, verifiable gap register that can hand off to strategy or case writing.

Workflow

  1. Read and follow the main prompt listed under Progressive disclosure (coverage, structure, quality bar).
  2. Run the fixed pipeline: intake → short-input gate → structure inventory → input audit → quality/smell/NFR → success metrics → behavior plus UX states → trace and goal-feature alignment → dependency grid → single register → risk algorithm → testability and oracles → blockers and next actions. Do not write risks or a “TOP 3” list first.
  3. Direct requirement materials remain sufficient for standalone use. If the user supplies role reports with a declared source_role, treat them as optional composition inputs and never require installing a role Skill.
  4. Add only project context that changes the result: scope, environment, constraints, risks, dependencies, expected deliverable.
  5. If input is incomplete, return a usable first draft and explicitly mark assumptions and gaps.
  6. Default to Markdown; switch formats only when the user asks.

Core Constraints

  • Produce exactly one gap and conflict register; do not also write “Gaps and Ambiguities”, “Cross-Source Conflicts”, or “Core Analysis Items”.
  • Audit credibility and comparability first; never mark stale or incomparable sources as aligned.
  • Prioritize by risk / business impact — do not treat everything equally.
  • Separate confirmed facts, role-report content, working assumptions, and hypotheses to verify.
  • Do not invent endpoints, fields, SLAs, environments, or root causes the user did not provide; unknowns become questions.
  • Do not fill business decisions for stakeholders, and do not judge whether the ask is worth building; keep both views and a suggested decider on conflicts. If an omission looks intentional, ask first.
  • When using a role report, preserve source_role item by item; never flatten into anonymous consensus or present a role view as a PRD fact.
  • Every P0/P1 item needs executable verification: preconditions, stimulus, expected result, required evidence, VerifyMethod, and RiskClass. Every P0 needs FailureMode.
  • Items with no observable failure condition are untestable and must not be executable P0. Do not emit a fake RPN, a 0–100 score, or a six-dimension traffic-light scorecard.

Progressive Disclosure

  • Before producing output, read and follow prompts/codexqa-requirement-analyzer.md (minimum coverage, output structure, quality bar).
  • When Excel/CSV/JSON/Word is requested: read output-formats.md and honor the format.
  • When a ready-made template fits: use matching files under output-templates/.
  • When the user wants examples or alignment with existing assets: read relevant examples/.
  • For register fields, troubleshooting, or FAQ: read references/register-fields.md, references/troubleshooting.md, or references/FAQ.md.
  • For quality-characteristic judgments: read references/quality-attributes.md.
  • For vague/optional/loophole wording: read references/requirement-smells.md.
  • For NFR completeness: read references/nfr-quality-grid.md.
  • For the structure inventory (present/thin/absent): read references/structure-inventory.md.
  • For success metrics / KPI: read references/success-metrics.md.
  • For upstream/downstream owner and ready dates: read references/dependency-grid.md.
  • For missing states/decisions/time/failure paths/UX states: read references/behavioral-completeness.md.
  • For P0–P3 ranking: read references/risk-scoring.md.
  • Do not load the whole references/ directory.
  • For format conversion or helper pre-parse: prefer existing TypeScript scripts in scripts/ (npx --yes tsx scripts/run_analysis.ts --input <file>); do not rewrite them in Python.
  • For evaluating/regressing this skill: use evals/ with skill-up.
  • For the shortest path: read quick-start.md.

Pre-delivery Checklist

  • Followed the main prompt's 7-section output structure; section 6 was not omitted
  • Produced one register only; questions were not restated in section 7
  • Covered the minimum checklist, or explained omissions
  • High-risk items have P0–P3 with impact / likelihood / detectability
  • Section 2 includes quality-characteristic hits, smell hits, the eight-cell NFR grid, structure inventory, success-metrics grid, and dependency grid
  • P0/P1 items include preconditions, stimulus, expected, evidence, VerifyMethod, and RiskClass; P0 includes FailureMode
  • Items without an oracle were not written as executable P0
  • Did not invent details the user did not provide
  • Assumptions and gaps are marked
  • Role-report findings retain source roles; no role Skill internal file was linked

Common Pitfalls

  • Concatenating three old analysis outlines and repeating gaps, risks, questions, and next steps.
  • Marking aligned when sources are stale or not comparable.
  • Pretending completeness when scope or context is missing.
  • Treating every item as equally important, or using filler (“improve communication”) instead of closable questions.
  • Listing checkpoints for P0 items without verification steps.
  • Writing a weak AC with no oracle as an executable P0, or using a score or traffic-light scorecard for false precision.
  • Labeling a missing KPI as NFR, or treating “out of this iteration” as missing.

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

and 4 more files.

Frequently asked questions

What does the Codexqa Requirement Analyzer AI skill do?

Full quality-and-risk analysis of requirement documents (single- or multi-source), producing one gap/conflict register with executable P0/P1 verification. Triggers: requirements analyzer, requirement quality, gap register, 需求分析, 需求分析器, 需求评审, 需求缺口. Not for writing a case library (that is codexqa-testcase-generator), constructing test data (codexqa-testdata-generator), or reviewing code (codexqa-defect-analyzer / codexqa-code-reviewer). Former skill name: requirements-analyzer.

Why use Codexqa Requirement Analyzer on TypingMind?

Because you install it once and use it with any model. Codexqa Requirement Analyzer is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Codexqa Requirement Analyzer in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/openqa-cn/codexqa/tree/main/skills/codexqa-requirement-analyzer. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Codexqa Requirement Analyzer?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Codexqa Requirement Analyzer?

As many as you like. As long as a model supports skills, you can use Codexqa Requirement Analyzer with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Codexqa Requirement Analyzer AI skill free?

Yes. It is published on GitHub by openqa-cn under the Apache-2.0 license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇