Skip to main content

Knowledge Base

The Knowledge Base is a project-level repository of reusable engineering documents — failure-mode catalogues, design patterns, lessons learned, control plans, and standard operating procedures — that NirmIQ can also use to enrich AI-generated requirements and FMEA suggestions.

Subscription Required
  • Knowledge Base CRUD (create / edit / delete documents): Professional tier and above
  • AI-generated KB documents (auto-generate documents from existing code or requirement patterns): Advanced tier and above
  • Free tier: Up to 5 read-only KB documents (teaser); no AI enrichment

What it is​

Each Knowledge Base entry is a structured document with:

  • A title and category (e.g. Failure Mode Library, Design Pattern, Lessons Learned)
  • Markdown body content
  • Optional tags
  • Optional links to specific requirements, FMEA failure modes, or test cases

When AI features run inside a project (FMEA generation, requirement quality scoring, gap analysis), NirmIQ retrieves the most relevant KB documents and passes them to the AI as additional context — improving relevance over a generic prompt.

Common uses​

  • Failure mode library — capture failure modes you have seen across past projects so future FMEAs benefit from prior experience
  • Standard control plans — describe the controls and detection methods your organisation considers acceptable for specific failure types
  • Lessons learned — write up the post-mortem of a real incident or recall, including the requirements that turned out to be missing
  • Design patterns — document approved architectural patterns that the AI should prefer when generating requirements
  • Compliance references — paste relevant excerpts from internal compliance handbooks so AI suggestions stay aligned with your standards

Access​

Click Knowledge Base in the left sidebar of any project. The sidebar entry is visible on Professional plans and above (read-only at Free).

Workflow​

  1. Browse templates — open Templates to see starter templates for common categories (Failure Mode Library, Lessons Learned, Control Plan)
  2. Import a starter template set — for new projects, importing a starter set seeds the project's KB with sensible scaffolding you can edit
  3. Create your own document — click + New Document, choose a category, write the content in Markdown
  4. Attach context — link the document to specific requirements, failure modes, or work items so AI features pick it up when those entities are involved
  5. Reindex when needed — after large bulk edits, click Reindex to refresh the AI retrieval index

How AI uses the KB​

When you trigger an AI feature inside a project, NirmIQ:

  1. Identifies the entities involved (requirement IDs, FMEA failure mode IDs, etc.)
  2. Retrieves the top-N most relevant KB documents
  3. Includes them in the prompt to the AI provider
  4. Uses the AI response, with the KB context, to produce its suggestion

KB documents are scoped to a single project — they do not leak across organisations or projects.

Limits per tier​

TierKB documentsDocuments available to AI
Free5 (read-only)0
ProfessionalUnlimited3
AdvancedUnlimitedUnlimited
PowerUnlimitedUnlimited
EnterpriseUnlimitedUnlimited
Code Intelligence Add-onInherits base planInherits base plan
  • AI Guardrails — Project Health Score, AI Quality Score, FMEA Gap Analysis, Release Readiness
  • Code Intelligence — Generates requirements and FMEA from your codebase; benefits from a populated KB
  • Work Items — Track implementation against requirements