🚀 go-pugleaf

This is an update on what I've found out about LSE/SCA and its reports feature.

I ended up copying the TPU source and am modifying the Internals report source.
That is something that I didn't want to do, but the report as it stood didn't
fulfill our requirements as they now stand.  The 2167A_design report relies
totally on tagged comments to generate the report, but we wanted changes to the
code (i/o imported/exported routines, types etc) to be automatically documented
when the code changes.  Since SCA stores this information for us, it was an
ideal place to derive our documentation - a tailored 2167A version.  I have
found the going slow (lack of TPU and SCA expertise) but I have made some great
strides in creating the document automatically.  I have spent 2 weeks so far
and expect 2 to 3 more to complete the task.

Those of you who are TPU and SCA experts should be able to do it much more
quickly. (We have none at DASD)

Here is our format, and what LSE/SCA does for us:

4.x.y     CSU name  (An Ada package in our case)
4.x.y.1   Requirements  (package level) - tagged
4.x.y.2   Unit (Package) Description    - tagged
4.x.y.2.1 Imported Data                 - auto generated
4.x.y.2.2 Exported Data                 - auto generated
4.x.y.2.3 Imported Services (Routines)  - auto generated
4.x.y.2.4 Exported Services (Routines)  - auto generated
4.x.y.2.5 CSU Data Structures           - auto generated
4.x.y.2.6 Local Data                    - auto generated
4.x.y.2.7 Local Services (Routines)     - auto generated
4.x.y.2.7.1 Requirements (for Local Services)  - tagged
4.x.y+1    CSU name  (An Ada package in our case)


You can see that most of the document (at least section 4) is automatically
done by the internals report and my changes to the TPU source.  We spent approx
20 man-months generating the top-level design (Chapter 3) and the detailed
design is usually much more engineer intensive.  So my spending 5 weeks on the
tool, and having the engineers tag the necessary items as they code should save
us a lot of man-months.

-------------------------------------------------------------------------------
Todd A Sorensen               Honeywell Defense Avionics Systems Division
(505) 828-5611                internet: tas@dasd.honeywell.com
                              fax: (505) 828-5500
-------------------------------------------------------------------------------