Skip to content

aakashpayun108/knowledge-bank-framework

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Knowledge Bank Framework (Healthcare Domain)

Purpose

The Knowledge Bank is the authoritative source of truth that feeds your Knowledge Graph for the Healthcare domain.

For every Line of Business (LOB), Business Area, and Business Function, the Knowledge Bank captures:

  • Definitions
  • Standards
  • Data sources
  • Entities
  • Relationships
  • Compliance rules
  • Operational practices

Because creating documentation for each LOB/Area/Function can be time-consuming, this framework provides a structured, repeatable approach to generate and maintain documentation—manually or using GitHub Copilot / any LLM—ensuring that any healthcare client can maintain a consistent, comprehensive Knowledge Bank.


Why It Matters

AI-First SDLC

LLMs use the Knowledge Bank to generate requirements, architectures, wireframes, and test plans aligned to your standards.

Consistency

Provides a uniform structure and shared terminology across teams and clients, reducing onboarding time and rework.

Governance

Maintains a single source of truth across documents, diagrams, and implementations, minimizing drift.

Scalability

Start with one Business Function → expand to all LOBs/Areas/Functions with the same reusable structure.


How to Use This Framework (High Level)

  1. Define your business hierarchy (LOB → Business Area → Business Function) in the Business Catalog.
  2. For any selected Business Function, generate a new Knowledge Bank using the instructions and templates provided here—either manually or via Copilot/LLM.
  3. Store generated files under the standard path:

/knowledge-bank/{function}/

  1. Keep the Knowledge Bank updated as business rules, standards, or regulations evolve.

Folder Structure


.github/
copilot-instructions.md                        # Rules for generating Knowledge Banks
prompts/
generate-knowledge-bank.prompt.md           # Command file for automation

templates/
kb-format.md                                   # Standard structure for Knowledge Banks
output-files/
README.template.md
stakeholders.template.md
processes.template.md
data-sources.template.md
standards.template.md
entities.template.md
relationships.template.md
apis.template.md
compliance.template.md
dq-governance.template.md
validation.template.md
kpis.template.md
prompts.template.md
templates.template.md
risks.template.md
faq.template.md
README.md

samples/
provider-data-management/
README.sample.md
stakeholders.sample.md
processes.sample.md
data-sources.sample.md
standards.sample.md
entities.sample.md
relationships.sample.md
apis.sample.md
compliance.sample.md
dq-governance.sample.md
validation.sample.md
kpis.sample.md
prompts.sample.md
templates.sample.md
risks.sample.md
faq.sample.md

catalog/
business-catalog.yaml                           # LOB → Business Area → Business Function hierarchy
README.md                                       # How to update the catalog
slugs.csv                                       # Maps friendly names to folder slugs

knowledge-bank/
(Copilot will create subfolders here for each Business Function)

Why This Structure?

  • .github/ → Contains Copilot instructions and automation prompts.
  • templates/ → Stores the canonical structure and output file templates.
  • samples/ → Provides reference examples for each output file.
  • catalog/ → Centralized business hierarchy and naming rules.
  • knowledge-bank/ → Destination for generated Knowledge Banks.

Repository Files (Explained)

A. .github/copilot-instructions.md

Path: .github/copilot-instructions.md
What: Defines rules for how Knowledge Banks must be generated and structured.
Why: Ensures consistent formatting, sections, filenames, and folder paths.

Contains:

  • Purpose and behavior
  • Required sections
  • Formatting rules
  • File manifest
  • Example workflow

B. .github/prompts/generate-knowledge-bank.prompt.md

Path: .github/prompts/generate-knowledge-bank.prompt.md
What: Automation command template for VS Code using Copilot Chat.
Why: Ensures files are created in the correct location with the correct structure.

Contains:

  • Inputs (Domain, LOB, Area, Function)
  • Tasks (create files under /knowledge-bank/{function}/)
  • Constraints (follow templates, insert placeholders where needed)

C. /templates/kb-format.md

Purpose: The canonical template specifying required structure and sections for every Knowledge Bank.
Why: Ensures consistency across all documentation.


D. /catalog/business-catalog.yaml

Defines:


LOB → Business Area → Business Function hierarchy

Why: Prevents ambiguity, drives folder structure, and enforces naming consistency.


E. /catalog/README.md

Explains how non-technical contributors can update the catalog safely.


F. /catalog/slugs.csv

Maps human-readable names to machine-friendly folder slugs (kebab-case).


Step-by-Step Guide

Generate a Knowledge Bank for Provider Data Management (Commercial LOB)

  1. Create the folder structure shown above.

  2. Add required baseline files.

  3. Open VS Code and enable Copilot Chat:

    • Open your Knowledge Bank repository.
    • Add relevant client repos to the same workspace.
    • Copilot can now read all repos together.
    • Enable GitHub Copilot Chat.
  4. Run this command in Copilot Chat:


/generate-knowledge-bank
domain=Healthcare 
lob=Commercial 
area=Provider Network Management 
function=Provider Data Management 
outdir=/knowledge-bank/commercial/provider-network-management/provider-data-management/

  1. Copilot will:

  2. Read the instructions and template

  3. Validate the hierarchy from the catalog

  4. Create the folder under /knowledge-bank/...

  5. Generate all required Markdown files

  6. Review & Commit

  • Verify that all files exist
  • Confirm sections match /templates/kb-format.md
  • Insert client-specific details where placeholders appear
  • Commit the folder to your repo

Output (Expected)

If successful, Copilot creates the following files under your Business Function folder:


README.md
stakeholders.md
processes.md
data-sources.md
standards.md
entities.md
relationships.md
apis.md
compliance.md
dq-governance.md
validation.md
kpis.md
prompts.md
templates.md
risks.md
faq.md

You can generate them using:


/generate-knowledge-bank
domain=Healthcare 
lob=Commercial 
area="Enter Business Area" 
function="Enter Business Function" 
outdir=/knowledge-bank/{lob}/{area}/{function}/


END OF REPORT

About

knowledge-bank-framework repo

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors