PWI Software Documentation Help

Creating New Documentation

This guide is for creating new software documentation articles.

Small Articles

  1. Write documentation completely.

  2. Create a pull request and request approval from Jeff.

  3. Merge the pull request and delete the branch.

Large Articles

  1. Write rough draft with minimal formatting (headers + numbered or bulleted lists only).

  2. Gain approval of basic content with a pull request + approval. Do not push to main after approval.

  3. Rewrite/finalize article as needed with final formatting.

  4. Create a pull request and request approval from Jeff.

  5. Merge the pull request and delete the branch

24 December 2024