Skip to content

Use more headings for structures with unique numbers #97

Description

@nicorikken

To me the current headings on the pages seem off in certain places. Take fore example 1.3 Produce Well-Secured Software (PW) Tasks for Code and Prebuild

Use headings

I expect al PW.1 items to have a heading, so they show up in the Table of Contents sidebar. Also that would create an anchor to link to.

Some pages have that, some don't.

Use unique numbers

At the moment it is hard to reference any item from the guide, because headings are not unique in name.

I would expect all PW.1 items to have unique names and numbers across the document, for explicit reference.

It would then become 1.PW.1 as an more readable version of 1.3.1. An idea could be to use letters for the phases as well, although it could be confusing. Alternatively the phases could be renamed to a character, like (CP, BD, PD), although that wouldn't work well with sorting.

Besides numbers, there could also be unique names, to prefix with the stage: "Code and Prebuild: Design Software to Meet Security Requirements and Mitigate Security Risks"

I think the changes will be minimal, but will help make the guide more readable and usable. I think there should be some consensus on the changes, to have a target for a pull-request.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions