Changes between Version 1 and Version 2 of GCI/Documentation/ClassicAPIRequirements


Ignore:
Timestamp:
Sep 12, 2018, 7:29:15 PM (10 months ago)
Author:
Gedare Bloom
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • GCI/Documentation/ClassicAPIRequirements

    v1 v2  
    22
    33[[TOC(GCI/Documentation/ClassicAPIRequirements , depth=2)]]
    4 
    5 Tasks related to creating/editing documents and helping others learn more
    6 
    7 We expect approximately 30 tasks in this category for the first round. There can be followup tasks sets to further refine them.
    84
    95This task is part of the RTEMS project's effort to reduce certification costs by easing requirements traceability. As we want our developers to spend more time on adding technical value (instead of updating duplicate documentation), we will want to merge as much of this documentation as possible.
     
    117We have several existing classic API documents and converting each into chapter into reStructuredText will provide a baseline which is easier for further automated processing and updates. The focus will be on the final versions of the RTEID and ORKID specifications.
    128
    13 ==  Classic API Requirements Document (Phase I Deliverables)  ==
     9We expect approximately 30 tasks in this category for the first round. There can be followup tasks sets to further refine them.
     10
     11
     12== Directions for Students ==
     13
     14===  Classic API Requirements Document (Phase I Deliverables)  ===
    1415
    1516The deliverable is a .rst
     17
    1618===  Classic API Requirements Document (Phase I Method)  ===
    1719
     
    29311. use ```` on items that are supposed to be code
    30321. Upload to melange, ask the mentor to review the .rst
     33
    3134===  Classic API Requirements Document (Phase I Example)  ===
    3235
     
    98101TBD: identify unified textual format
    99102
    100 ===  Note to Mentors  ===
     103==  Directions for Mentors  ==
    101104
    1021051. Verify the .rst renders in the [http://rst.ninjs.org/ RST editor]