SRAP Review: Documentation #131
Description
Guidelines regarding general points:
- Does the documentation make sufficiently clear why SRAP is needed in the first place?
- Is the documentation clearly written, well structured, easy to read (for humans)? adapted to the target group?
- Does the documentation contain enough and clear enough examples for:
- the elements of SRAP itself?
- use cases?
- systems that are supposed to use SRAP? technical instructions for that?
- Are the design decisions documented in a transparent way, and do they actually serve the why of SRAP?
- Summing up: does the documentation serve its purpose, is it comprehensive enough, and is it ready for official publication?