This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Create requirement-writing guide/template #263

Open

camerons opened this issue Jul 27, 2022 · 1 comment

Labels

templates templates-p3

Member

camerons commented Jul 27, 2022 •

edited

Loading

Create requirement-writing guide

Template description

There are a range of best practices for writing a good requirement. One version is:

After one year of level-2 usage, the battery-life, MUST, last 10 hours, when running level-3 applications.
{Condition} the {subject} {compliance} {verb} {object} {qualification}

Tasks

@camerons has developed a requirement-writing guide within Google, and has obtained legal approval to release this material to The Good Docs Project. @camerons to copy the material into github.
Possibly add a simple template file, to complement the guide.
Review the material and possibly refine to align with style practices within The Good Docs Project.

Helpful resources

camerons added templates templates-p3 labels

Member Author

camerons commented Jul 27, 2022

First import of material is in https://github.com/thegooddocsproject/templates/tree/requirements/requirement

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.