ProficientNowTechRFCs
RFC Standards/RFC Kinds/Specification/RFC RFCSTD 0003

3. Structure Definition

RFC-RFCSTD-0003                                                   Section 3
Category: Standards Track                            Structure Definition

3. Structure Definition

← Requirements | Index | Next →


3.1 Required Sections for Specification Kind

SectionFileRequirementPurpose
Index00-index.mdREQUIREDMetadata, abstract, architecture reference
Prerequisites01-prerequisites.mdREQUIREDRequired and optional dependencies
Phases02-phases.mdREQUIREDPhased implementation (task → test → iterate)
Resources03-resources.mdREQUIREDResource tables (no YAML/JSON)
Validation04-validation.mdREQUIREDDeterministic verification criteria
Testing05-testing.mdREQUIREDTest categories and acceptance criteria
Risks06-risks.mdREQUIREDFeatures, caveats, loopholes, risks, mitigations
Glossaryappendix-a-glossary.mdREQUIREDTerms
Referencesappendix-b-references.mdREQUIREDArchitecture RFC references

3.2 Section Requirement Levels

LevelMeaningOmission Criteria
REQUIREDSection MUST be presentCannot be omitted

All Specification RFC sections are REQUIRED because:

  • Prerequisites: Implementers need to know dependencies
  • Phases: Implementation must be structured
  • Resources: Implementers need to know what to create
  • Validation: Correctness must be verifiable
  • Testing: Quality must be ensured
  • Risks: Implementers must understand limitations

3.3 Section Content Requirements

3.3.1 Index Section (00-index.md)

The index MUST include:

ComponentRequirementDescription
RFC HeaderREQUIREDStandard header block
Metadata TableREQUIREDAll fields including Kind: Specification
Implements FieldREQUIREDReference to Architecture RFC
AbstractREQUIREDImplementation summary
Scope BoundariesREQUIREDWhat this spec covers and doesn't
Table of ContentsREQUIREDLinks to all sections

3.3.2 Prerequisites Section (01-prerequisites.md)

The prerequisites section MUST include:

ComponentRequirementDescription
Infrastructure PrerequisitesREQUIREDPlatform requirements
Access PrerequisitesREQUIREDCredentials and permissions
Knowledge PrerequisitesRECOMMENDEDRequired understanding
Tooling PrerequisitesRECOMMENDEDRequired tools

Each prerequisite MUST have:

AttributeDescription
NameWhat is needed
TypeRequired or Optional
VersionMinimum version (if applicable)
VerificationHow to check if met

3.3.3 Phases Section (02-phases.md)

The phases section MUST include:

ComponentRequirementDescription
Phase OverviewREQUIREDSummary of all phases
Phase DefinitionsREQUIREDDetailed phase descriptions
Rollback ProceduresREQUIREDHow to undo each phase

Each phase MUST have:

AttributeDescription
Phase NumberSequential identifier
Phase NameDescriptive title
TasksWhat to do (not how—no commands)
TestHow to verify completion
IterateWhat to check before proceeding
RollbackHow to undo if needed

3.3.4 Resources Section (03-resources.md)

The resources section MUST include:

ComponentRequirementDescription
Resource OverviewREQUIREDSummary of all resources
Resource TablesREQUIREDDetailed resource definitions
Dependency GraphRECOMMENDEDResource creation order

Each resource MUST have:

AttributeDescription
NameResource identifier
TypeResource kind (ConfigMap, Secret, etc.)
PurposeWhy this resource exists
DependenciesWhat must exist first
ValidationHow to verify correct creation

3.3.5 Validation Section (04-validation.md)

The validation section MUST include:

ComponentRequirementDescription
Validation OverviewREQUIREDWhat validation means for this spec
Validation CriteriaREQUIREDIndividual criteria
Validation ProcedureREQUIREDHow to perform validation

Each criterion MUST have:

AttributeDescription
Criterion IDUnique identifier
DescriptionWhat is being validated
MethodHow to validate
Pass ConditionWhat constitutes passing

3.3.6 Testing Section (05-testing.md)

The testing section MUST include:

ComponentRequirementDescription
Test CategoriesREQUIREDTypes of tests
Acceptance CriteriaREQUIREDWhat defines passing
Test EnvironmentRECOMMENDEDWhere tests run
Test DataRECOMMENDEDWhat data is needed

Each test category MUST have:

AttributeDescription
Category NameType of test
PurposeWhat this category verifies
ScopeWhat is included/excluded
AcceptancePass/fail criteria

3.3.7 Risks Section (06-risks.md)

The risks section MUST include:

ComponentRequirementDescription
FeaturesREQUIREDWhat the implementation provides
CaveatsREQUIREDKnown limitations
LoopholesRECOMMENDEDEdge cases not covered
RisksREQUIREDWhat can go wrong
MitigationsREQUIREDHow risks are addressed

Each risk MUST have:

AttributeDescription
Risk IDUnique identifier
DescriptionWhat the risk is
LikelihoodHow likely (High/Medium/Low)
ImpactHow severe (High/Medium/Low)
MitigationHow to address

3.4 File Naming Convention

PatternUsage
00-index.mdIndex
01-prerequisites.mdPrerequisites
02-phases.mdImplementation phases
03-resources.mdResource definitions
04-validation.mdValidation criteria
05-testing.mdTest requirements
06-risks.mdRisk documentation
appendix-<letter>-<name>.mdAppendices

End of Section 3 — RFC-RFCSTD-0003