diff --git a/doc/config.yml b/doc/config.yml index 6b3d5eb5ef..153158a7ca 100644 --- a/doc/config.yml +++ b/doc/config.yml @@ -25,6 +25,7 @@ Renderer: Theory: manuals/theory/index.md Software Quality: sqa/index.md User: manuals/user/index.md + Developer: manuals/developer/index.md Documentation: Syntax: syntax/index.md Help: diff --git a/doc/content/manuals/developer/index.md b/doc/content/manuals/developer/index.md new file mode 100644 index 0000000000..6da6d97602 --- /dev/null +++ b/doc/content/manuals/developer/index.md @@ -0,0 +1,3 @@ +# Developer Manual + +!include include/developer/documentation.md diff --git a/doc/content/manuals/include/developer/documentation.md b/doc/content/manuals/include/developer/documentation.md new file mode 100644 index 0000000000..ed964a9ab7 --- /dev/null +++ b/doc/content/manuals/include/developer/documentation.md @@ -0,0 +1,58 @@ +## Instructions for documentation + +Prior to merging the code, MOOSE and MASTODON require adequate documentation +describing the implemented feature, such as materials, post processors, etc. +Several tools are available for MOOSE-based documentation, and these tools are +described [here](utilities/MooseDocs/index.md). +For each new feature, the following documentation files are required. + +#### Documentation of C++ objects + +For each C++ object created, the developer should include the documentation as +prescribed by [MOOSE requirements](utilities/MooseDocs/generate.md). + +#### User manual + +For each feature (such as material, boundary condition, etc., which may include +one of more C++ objects), the developer must create one documentation file that +describes the method of usage of this feature. This file must be named as +`-user.md` and be placed in the appropriate sub folder in +`content/manuals/include`. A rough template for the user manual document is +below. + +``` +# + +Introduction and link to the corresponding theory manual document. + +Objects needed to simulate this feature. Links to the documentation of these +objects. + +Associated actions, and usage in the Mastodon block, if available. Link to the +documentation of the corresponding Mastodon block action. + +Quick demo of this feature including listings of input files and sample results. + +``` + +#### Theory manual + +For each feature (such as material, boundary condition, etc., which may include +one of more C++ objects), the developer must create one documentation file that +describes the theory behind this feature. This file must be named as +`-theory.md` and be placed in the appropriate sub folder in +`content/manuals/include`. A rough template for the theory manual document is +below. + +``` +# + +Introduction about what the feature does and a link to the corresponding user +manual document. + +Description of the physics, or the theory behind the feature including +references, equations, figures, etc. + +Limitations, if any, of the implementation of this feature in MASTODON. + +```