Feature Tracking & Documentation Guide

This document is the canonical reference for how features, work items, and artifacts are tracked in this project. Follow these conventions to prevent duplicate documentation and keep the project organized.

GitHub Issues: Source of Truth for Features

All feature descriptions, enhancements, and known issues live as GitHub Issues in the PowerDataInc/priam repository. Do not create separate markdown files to describe features — put that content in a GitHub Issue instead.

Label Taxonomy

Every issue must carry one label from each relevant group:

Module labels (`module:*`)

Label	Scope
`module:assets`	Employee, customer, supplier, device, vehicle management
`module:auth`	Authentication (Better Auth, session, password reset)
`module:rbac`	Roles, permissions, access control
`module:dashboard`	Dashboard widgets, charts, aggregations
`module:incidents`	Incident lifecycle, queue workers, notifications
`module:policies`	Policy authoring, lifecycle, templates, approvals
`module:risk`	DAG engine, scoring, NAICS, assessments
`module:tenants`	Onboarding, tenant profile, subscription tiers, HIPAA

Type labels (`type:*`)

Label	When to use
`type:feature`	Fully implemented functionality
`type:enhancement`	Planned improvement or new capability
`type:bug`	Defect in existing behavior

Status labels (`status:*`)

Label	When to use
`status:complete`	Shipped and working in production
`status:in-progress`	Actively being worked on
`status:planned`	Approved but not started
`status:blocked`	Waiting on a dependency
`status:deprecated`	Removed or superseded

Priority labels (`priority:*`)

Use priority:high, priority:medium, priority:low for planned and in-progress items.

Issue Structure

Use this template when creating a new issue:

A one-paragraph description of what the feature does and why it exists.

## Details
- Bullet points for sub-features, edge cases, or implementation notes
- Reference relevant files or API routes

---
_Source: `path/to/originating/doc.md`_

Workflow: Adding a New Feature or Enhancement

Check for duplicates first. Search GitHub Issues before creating a new one. Use module labels to filter.
Create a GitHub Issue — not a markdown file. Include a clear title, description, module label, type label, and status label.
Reference the issue in commits using #<issue-number> in the commit message body.
Update the issue status when work starts (status:in-progress) and when it ships (status:complete).
Close the issue with a reference to the PR or commit that implemented it.

What Belongs in Markdown Files vs GitHub Issues

Content type	Where it lives
Feature description / user story	GitHub Issue
Known bug	GitHub Issue (`type:bug`)
Planned enhancement	GitHub Issue (`type:enhancement`, `status:planned`)
API endpoint reference	`docs/developer-guide/API_REFERENCE.md`
RBAC permission matrix	`docs/developer-guide/RBAC_Matrix.md`
Security audit findings	`docs/security-audit/`
User-facing how-to guide	`docs/user-guide/`
Codebase onboarding / conventions	`CLAUDE.md`
Data model schemas	`FIRESTORE_MIGRATION.md`
Testing strategy	`docs/TESTING.md`

What NOT to Create

Do not create feature-description markdown files in the root, .claude/, or docs/ that duplicate GitHub issue content.
Do not keep AI-generated context dumps (e.g., outputs/context/*.md) after the features they describe have been captured as issues.
Do not store generation prompts (PROMPT.md-style files) in the repository.
Do not create a new TODO file — use GitHub Issues with status:planned instead.

Current Issue Coverage (as of 2026-05-23)

Issues #2–#62 at https://github.com/PowerDataInc/priam/issues were created from the following source files:

Source file	Issues created
`.claude/outputs/context/01-09-*.md`	Auth, Onboarding, Employees, Assets, Incidents, Risk Assessment, Dashboard, HIPAA, Policy Management
`docs/developer-guide/RBAC_Matrix.md`	#6
`docs/developer-guide/INDUSTRY-AWARE-RISK-SCORING.md`	#12
`docs/developer-guide/POLICY_TEMPLATE_PLATFORM_PLAN.md`	#20, #23
`docs/developer-guide/PLATFORM_ADMIN.md`	#22, #24
`docs/developer-guide/INCIDENT-STANDALONE-PLAN.md`	#43, #44
`docs/developer-guide/NAICS_LOOKUP_GUIDE.md`	#59
`docs/security-audit/security-audit-2026-04-25.md`	#31
`.claude/TODO.md`	#30 and various planned items
`.claude/PROJECT_CONTEXT.md`	Multiple architecture and platform issues