docs.md

reqmd documentation

This directory contains detailed technical documentation for the reqmd tool, covering requirements, design, syntax specifications.

Syntax and structure of input files

Ref. ebnf.md

Use cases

• Installation
• Tracing

Options

• Ignore .* folders
• Ignore paths by pattern
• Ignore lines by pattern
• Force requirement types

Syntax/semantic errors

• Handle inconsistency between Footnote and PackageId

See also:

• internal/errors_syn.go
• internal/errors_sem.go

Test requirements

• System tests
  • Golden data embedding to avoid separate .md_ files
• High-volume file processing test

Other

• Architecture - Architecture and implementation design
• Construction requirements
• Processing phases
• Decisions

Research

• Research Notes - Research and study notes