mystransolver / mystran_documentation

Documentation Resources for MYSTRAN

MYSTRAN Documentation Breakdown and Process

For the MYSTRAN project, there are 4 major formal documents and also an "Other" directory:

• Quick Reference Guide
• User Manual
• Theory Manual
• Release Notes
• Other

Quick Reference Guide

The Quick Reference Guide is intended to be the first document the user sees and will allow one to get up speed as soon as possible.

The Quick Reference Guide is created in InDesign because this is the highest quality document that can be produced. However, it is not flexible with regard to modification. Because this document is relatively small, InDeisgn is a candidate (The much larger User and Theory manuals are not canditates for InDesign). For major releases (or every so often), the InDesign document is updated and a PDF is created, which will reside in this repo and the main MYSTRAN repo.

Modification Process: This is a special document that will be modified only by specific developers.

User Manual

The User Manual is the largest and most thorough document in the MYSTRAN documentation suite. It contains detailed information about the how to use the program.

The user manual is in MS Word (docx) because this is a good balance between design and flexibility. The Word document can then create a PDF, which will reside in this repo and the main MYSTRAN repo.

Modification Process: Any document request changes/requests can be reported as a GitHub Issue. Then, for major releases (or every so often), the Word document is updated and a PDF is created. For minor changes, a variety of developers can implement the changes without oversight. For significant changes, such as major section rewrites, it is recommended that changes be approved by at least one other developer.

Theory Manual

The Theory Manual contains detailed information about the theory and math utilized for the MYSTRAN solver.

The theory manual is in MS Word (docx) because this is a good balance between design and flexibility. The Word document can then create a PDF, which will reside in this repo and the main MYSTRAN repo.

Modification Process: Any document request changes/requests can be reported as a GitHub Issue. Then, for major releases (or every so often), the Word document is updated and a PDF is created. For minor changes, a variety of developers can implement the changes without oversight. For significant changes, such as major section rewrites, it is recommended that changes be approved by at least one other developer.

Release Notes

The Release Notes document is done with Markdown (MD). This document has minimal design requirements and using MD allows for ease of editing and tracking.

Other

In this folder, there are various documents that are related to MYSTRAN, but are not considered "formal" documents.