USACE / USACE/chart-docs

User Documentation: Write a Technical Reference Manual

Open
#69 1 comment 0 reactions 1 assignee View on GitHub

@KHodgens is already working on this.

Since Jun 4, 2024.

documentation
Dominant language
No language data
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

It is the responsibility of each of the disciplines to describe how the tool works under the hood in plain language in the technical reference manual. For each of your parts of the program:

  1. Describe the theory that the code is implementing. For example, if you need to combine functions, you'll rely on function composition and meeting the mathematical criteria for the definition of a function.
  2. Describe how the code works. Make sure to describe validation, how are different situations handled. For example, how is a normal distribution centered on 1 with a standard deviation of 1 handled?
  3. Document assumptions made in writing code and motivate assumptions. For example, what do you assume about when houses get wet between frequencies where one frequency is dry and the other is wet?

Every piece of code that does something toward shaping the result needs to be documented here:
https://www.hec.usace.army.mil/confluence/display/CSTD

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.