| Target release | Release name or number |
|---|---|
| Epic | Link to related JIRA epic or feature |
| Document status | |
| Document owner | |
| Designer | Lead designer |
| Developers | Lead developer |
| QA | Lead tester |
|
| # | 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 |
| Tools | Source formats | Ouput formats | Pros | Cons | Notes | |
|---|---|---|---|---|---|---|
Continue with FrameMaker | Frame, MagicDraw | move to DITA, XMI | PDF, HTML | |||
Move to Madcap Flare | Madcap Flare, MagicDraw | DITA, XMI | PDF, HTML, other | |||
| HTML authoring + MagicDraw | MagicDraw, HTML tools | XMI, HTML | HTML | |||
| ODF-based solution (MagicDraw) | MagicDraw, Word | Apache OpenOffice | ODF tools Achieved using MagicDraw's embedded Velocity statement approach | ODF, XMI | PDF, HTML | |||
| ODF-based solution (manual) | MagicDraw, Word | Apache OpenOffice | ODF tools | ODF, XMI | ||||
| Asciidoc-based solution | MagicDraw, AsciiDoctor | XMI, AsciiDoc | ||||
| Markdown-based solution | MagicDraw, text editor | markdown text, XMI | ||||
| EPub based solution | brackets |
Below is a list of questions to be addressed as a result of this requirements document:
| Question | Outcome |
|---|---|
| (e.g. How we make users more aware of this feature?) | Communicate the decision reached |