Skip to main content

spec-template


id: SPEC-NNN title: version: 1.0.0 type: features status: draft user_story: US-NNN priority: <High | Medium | Low> complexity: <Low | Medium | Medium-High | High> estimated_effort: <N-M dev days> module: <Module(s) from US> prefix: <Affix> id_range: <from>-<to> created_date: <YYYY-MM-DD> approved_date: "" template: 2_Spec_Template.docx language: en

SPEC-NNN – <Title>

User Story Reference

As a I want so that

All Acceptance Criteria of US-NNN are addressed in §7 of this document.

Technical Design Overview

2.1 Design Principles

#PrincipleRationale
1

2.2 Architecture

erDiagram
%% replace with the real data model
PARENT ||--o{ CHILD : has

2.3 Out-of-Scope Confirmation

The following items from US-NNN remain explicitly out of scope of this spec:

AL Object Inventory

3.1 Tables

IDObject NamePurpose
<Affix> <Name>

3.2 Enums

IDObject NamePurpose

3.3 Pages

IDObject NamePage TypeSource Table

3.4 Page Extensions

IDObject NameExtends

3.5 Codeunits

IDObject NamePurpose

3.6 Permission Sets

IDObject NameScope

3.7 Number Series

CodeDescriptionUsed by

3.8 ID Allocation Summary

RangeTypeStatus
-Used / Reserved

Table Field Definitions

4.1 Table <Affix> <Name>

Field No.Field NameData TypeLength / PropertiesNotes

Keys:

Triggers:

Page Design Notes

5.1 Page <Affix> <Name>

  • Layout: <groups, repeater, factboxes>
  • Actions:
  • Visibility / promotion:

Integration with Standard BC Objects

Standard ObjectInteraction
Codeunit "No. Series"

Technical Acceptance Criteria

IDDescriptionMaps to US-AC
AC-TBL-001US-NNN / AC1
AC-FLD-001US-NNN / AC1
AC-PAGE-001US-NNN / AC2
AC-CU-001US-NNN / AC3
AC-PERM-001US-NNN / AC10
AC-LANG-001All captions/labels translated in translations/*.xlfAll

Phase Overview

PhaseSlugNameEffort (dev days)Description
1master-dataMaster Data & Setup
2coreCore Entity & UI
3integrationStandard BC Integration
4polishPermissions, Translations & Tests

Total estimated effort:

Testing Strategy

  • Phase 1: test/<feature>/<Feature>SetupTests.Codeunit.al
  • Phase 2: test/<feature>/<Feature>CoreTests.Codeunit.al
  • Phase 3: test/<feature>/<Feature>IntegrationTests.Codeunit.al
  • Phase 4: smoke tests + translation sanity check via NAB AL Tools.

Dependencies

DependencySourceResolution
<module / app>

Open Questions Tracking

#FromStatusResolution proposed in this spec
OQ-01US-NNN<Resolved / Not blocking / Escalated>

Phase Plans

  1. Phase 1 — Master Data & Setup
  2. Phase 2 — Core Entity & UI
  3. Phase 3 — Standard BC Integration
  4. Phase 4 — Polish, Permissions & Translations