Documentation

Install and Run

# Install via Brew -- COMING SOON

# Install script
curl -fsSL https://raw.githubusercontent.com/walkerbrown/goodwrite/main/scripts/install.sh | bash

# check
goodwrite check docs/**/*.md docs/**/*.typ

# fix machine-applicable diagnostics
goodwrite fix docs/manual.md

# create starter config
goodwrite init

Config Boundary

Ruleset identity is external to source files:

• Set default/active requirement rulesets in goodwrite.toml.
• Override per invocation with --requirement-ruleset.
• Source annotations never select a ruleset.

Requirement Syntax

Requirement type vocabulary comes from active requirement rulesets (EARS by default).

<!-- goodwrite:requirement -->
The system shall reset in less than 100 ms.
<!-- goodwrite:requirement:end -->

<!-- optional type -->
<!-- goodwrite:requirement:state-driven -->
While battery voltage is below 22.0 V,
the system shall reduce transmit power.
<!-- goodwrite:requirement:end -->

#requirement[
The system shall reset in less than 100 ms.
]

#requirement_state[
While battery voltage is below 22.0 V,
  the system shall reduce transmit power.
]