wiki:GCI/Documentation/SoftwareEngineeringHandbook

RTEMS Software Engineering Handbook

Task Description

This set of tasks involve assembling documentation from the Wiki and from an assembled draft to create a new RTEMS manual, the "Software Engineering Handbook". One task instance is made for the initial import of the current draft into rtems-docs.git, and one or more tasks for updating each chapter of the draft.

Directions for Students

Refer to the task directions on the Code-In app.

The outline of the Software Engineering Handbook is:

  1. Introduction to RTEMS
  2. RTEMS Pre-Qualification
  3. Software Development Management
    • Implementation Details
    • Coding Standards
    • Change Management
    • Issue Tracking - TRAC usage
  4. Software Test Plan Assurance and Procedures
    • Scope
    • Procedures
    • Methodologies
    • Tools
  5. Software Release Management
    • Software Change Report Generation
    • Version Description Document (VDD) Generation
  6. User’s Manuals
  7. Licensing Requirements
  8. References
  9. Appendices

Directions for Mentors

Based on the chapter assigned for the student's task verify that the draft document has been updated with a thorough and well-edited integration of the relevant documentation.

Last modified on Oct 20, 2018 at 3:52:47 PM Last modified on Oct 20, 2018, 3:52:47 PM