UNPKG

aiwg

Version:

Cognitive architecture for AI-augmented software development with structured memory, ensemble validation, and closed-loop correction. FAIR-aligned artifacts, 84% cost reduction via human-in-the-loop, standards adopted by 100+ organizations.

77 lines (45 loc) 2.28 kB
# Use-Case Modeling Guidelines Template ## Cover Page - ``Project Name`` - `Use-Case Modeling Guidelines` - `Version`1.0`` ## Revision History | Date | Version | Description | Author | | --- | --- | --- | --- | | ``dd/mmm/yy``|``x.x``|`<details>`|`<name>` | ## Ownership & Collaboration - Document Owner: Environment Engineer - Contributor Roles: System Analyst, Requirements Reviewer - Automation Inputs: Use-case modeling conventions, review checklist - Automation Outputs: `use-case-modeling-guidelines.md` covering sections 1–8 ## 1 Introduction > Outline purpose, scope, terminology, references, and document structure. ### 1.1 Purpose ### 1.2 Scope ### 1.3 Definitions, Acronyms, and Abbreviations ### 1.4 References ### 1.5 Overview ## 2 General Modeling Conventions > Specify notation choices, diagram usage, package structure, and modeling policies (extends/includes, generalization, > etc.). ## 3 Actor Modeling Guidelines > Describe how to discover, name, and document actors, including stereotypes and relationships. ## 4 Use-Case Specification Guidelines > Provide rules for writing use-case briefs, fully dressed use cases, alternate flows, extension points, and special > requirements. ## 5 Use-Case Diagram Guidelines > Define layout conventions, naming standards, and usage of system boundaries, relationships, and packages. ## 6 Traceability and Organization > Explain how use cases trace to business processes, requirements, tests, and architecture elements. ## 7 UML Stereotypes and Extensions > Record project-specific stereotypes, tagged values, and constraints applicable to the use-case model. ## 8 Review Checklist > Provide a checklist for validating completeness and quality of use-case artifacts. ## Appendices (Optional) > Include examples, templates, or narrative guidelines for consistent authoring. ## Agent Notes - Include naming conventions so generated use-case files follow consistent identifiers. - Call out review checkpoints agents must satisfy before accepting a use-case spec. - Verify the Automation Outputs entry is satisfied before signaling completion. - Define naming conventions so automation generates consistent identifiers. - List acceptance checks that must pass before approving a use-case spec.