This wiki has undergone a migration to Confluence found Here
HMD and Model documentation for ballots
Jump to navigation
Jump to search
The questions below address issues for model and HMD documentation in V3 messaging ballot packages. Please provide answers and discussions as commentary. Also add new questions if they are relevant.
- Should committees create class level narratives to go along with RMIM diagrams?
- If they do so, should the contents of this narratives also be included in HMDs?
- If committees provide DMIMs, should narratives be included for the DMIM or the RMIM?
- If there is a DMIM narrative, should the descriptions be duplicated in the RMIM?
- If there is a DMIM narrative, should RMIM narratives contains descriptions for classes that are specializations of DMIM classes?
- Or that are used in specialized ways?
- When committees provide DMIM and RMIM level narratives, should these only describe classes, or should they describe attributes as well?
- Or should attribute level descriptions go into the HMDs?
- If committee’s choose to provide attribute level descriptions, should these include all attributes?
- That is, should the descriptions in the RIM be duplicated, or should committees only add further detail to explain where an attribute is used in a specialized way?
- IN OTHER WORDS: Should committees assume that balloters have some familiarity with the RIM?
- That is, should the descriptions in the RIM be duplicated, or should committees only add further detail to explain where an attribute is used in a specialized way?
- If committees are to assume some level of familiarity with the RIM, how deep should that go?