Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-21228

Provide places for code design and development documentation

    XMLWordPrintable

    Details

    • Type: Story
    • Status: To Do
    • Resolution: Unresolved
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None

      Description

      Our current documentation structure such as DMTNs and Science Pipelines module pages does not provide an obvious place to record design and development documentation.  Please provide and document such places.  Suggestions include:

      • For preliminary architecture and design work, specify that DMTNs are the appropriate vehicle.
      • For Python module-associated documentation that explains how to use internal APIs and describes the reasoning behind the design and implementation, specify that a dev subdirectory of the doc directory is the appropriate place, with pages linked to the module page in a "Design and Development" section that also contains the current content of the "Contributing" section.
      • For Web services, it's possible that an entirely separate document hierarchy should be used, though still hosted with the code in its repositories.

        Attachments

          Activity

          There are no comments yet on this issue.

            People

            Assignee:
            jsick Jonathan Sick
            Reporter:
            ktl Kian-Tat Lim
            Watchers:
            Kian-Tat Lim
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:

                Jenkins

                No builds found.