Goals
- reduce cost of tooling
- enable multiple users and tools to interact with specifications content
Assumptions
- 'Users' assumed to be in the Specifications Editorial Committee
Requirements
| # | Title | User Story | Importance | Notes |
|---|---|---|---|---|
| Authoring | ||||
| A1 | open source format | enables multiple tools to edit | Required | |
| A2 | text source format | amenable to versioning tools | Required | |
| A3 | UML-tool based | |||
| Publishing | ||||
| P1 | Single source publishing | one set of source artefacts to generate all outputs | ||
| P2 | Can generate HTML website |
Alternatives
| Tools | Pros | Cons | Notes | |
|---|---|---|---|---|
Continue with FrameMaker | Frame, MagicDraw | |||
Move to Madcap Flare | Madcap Flare, MagicDraw | |||
| ODF-based solution (MagicDraw) | MagicDraw, Word | Apache OpenOffice | ODF tools Achieved using MagicDraw's embedded Velocity statement approach | |||
| ODF-based solution (manual) | MagicDraw, Word | Apache OpenOffice | ODF tools | |||
| Asciidoc-based solution | MagicDraw, AsciiDoctor | |||
| Markdown-based solution | MagicDraw, text editor | |||
| EPub based solution | brackets |
Questions
Below is a list of questions to be addressed as a result of this requirements document:
| Question | Outcome |
|---|---|