Notice: We have migrated to GitLab launching 2024-05-01 see here:

#3738 assigned project

Refactor the Software Engineering Manual

Reported by: Gedare Bloom Owned by: Joel Sherrill
Priority: normal Milestone: Indefinite
Component: doc Version: 6
Severity: normal Keywords: docs
Cc: Chris Johns, Gedare Bloom Blocked By:

Description (last modified by Joel Sherrill)

The newest RTEMS Manual is the Software Engineering (SwE) Manual, which is intended to document the software engineering practices of RTEMS development. This project will improve the completeness and consistency of the SwE Manual with respect to primary sources and our intentions for this manual's use.

One of the main sources of content for the SwE book is our wiki. We would like to have the content of the SwE manual cross-checked with the respective wiki pages, and have those wiki pages be replaced with a link to the SwE book as the authoritative source for the information moving forward. This check should ensure the content is correctly reproduced, and identify any re-formatting that should be done in the manual to improve typesetting etc.

  • The primary remaining task is to review sections taken from the wiki, ensure the conversion looks correct, delete the wiki page, and correct all references from the web to the delete page.

In addition, the flow and organization of the SwE Manual likely could be greatly improved. We created the manual by filling in an outline with large dumps of text. A balanced and thoughtful approach to the manual's organization would likely provide great benefits to its usability and maintenance.

Change History (1)

comment:1 Changed on 01/14/20 at 21:16:19 by Joel Sherrill

Description: modified (diff)
Keywords: SoC removed
Note: See TracTickets for help on using tickets.