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

Timestamp:

09/12/18 19:29:15 (6 years ago)

Author:

Gedare Bloom

Comment:

--

GCI/Documentation/ClassicAPIRequirements

@@ -2 +2 @@
 
 [[TOC(GCI/Documentation/ClassicAPIRequirements , depth=2)]]
-
-Tasks related to creating/editing documents and helping others learn more
-
-We expect approximately 30 tasks in this category for the first round. There can be followup tasks sets to further refine them.
 
 This 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. 
@@ -11 +7 @@
 We 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.
 
-==  Classic API Requirements Document (Phase I Deliverables)  ==
+We expect approximately 30 tasks in this category for the first round. There can be followup tasks sets to further refine them.
+
+
+== Directions for Students ==
+
+===  Classic API Requirements Document (Phase I Deliverables)  ===
 
 The deliverable is a .rst
+
 ===  Classic API Requirements Document (Phase I Method)  ===
 
@@ -29 +31 @@
 1. use ```` on items that are supposed to be code
 1. Upload to melange, ask the mentor to review the .rst
+
 ===  Classic API Requirements Document (Phase I Example)  ===
 
@@ -98 +101 @@
 TBD: identify unified textual format
 
-===  Note to Mentors  ===
+==  Directions for Mentors  ==
 
 1. Verify the .rst renders in the [http://rst.ninjs.org/ RST editor]