riverma
commented
1 year ago @NASA-AMMOS/slim-tsc - thoughts on the below template? Are we missing anything or any suggestions? Please take a look at our current guides to see applicability.
---- Start Markdown Rendering Below ----
Title Goes Here
One sentence description of your process improvement solution / proposed standard.
Introduction
Background: A longer description of the problem you aim to solve and your solution. Talk about the background of why this is needed, what kind of benefits the user might enjoy, and any other background information that may be useful for the reader.
Use Cases:
- A list of the types of use cases where your process improvement solution will shine
- e.g. Making code repository README's consistent for internal and external contributors
Prerequisites
List any software, hardware, or skills required to utilize the solution.
- Prerequisite 1
- Prerequisite 2
- ...
Quick Start
Link to Process Improvement Solution (template/code sample/tool/etc.)
A brief description of what the link provides, e.g., "Click the link above to access the full template for the README.md file."
Step-by-Step Guide
-
Step 1: Brief description of the step.
-
Step 2: Brief description of the step.
-
...
Credits
Authorship:
- List of contributing authors of this write-up who actually wrote words. Link to GitHub profiles if available, e.g. Bugs Bunny
Acknowledgements:
- Source/Organization 1 that inspired the solution or was adapted from
- Source/Organization 2 that inspired the solution or was adapted from
- ...
Feedback and Contributions
We welcome feedback and contributions to help improve and grow this page. Please see our contribution guidelines.
---- End Markdown Rendering ----
---- Start Markdown Code Below ----
# _Title Goes Here_
<pre align="center">One sentence description of your process improvement solution / proposed standard.</pre>
## Introduction
**Background**: _A longer description of the problem you aim to solve and your solution. Talk about the background of why this is needed, what kind of benefits the user might enjoy, and any other background information that may be useful for the reader._
**Use Cases**:
- _A list of the types of use cases where your process improvement solution will shine_
- _e.g. Making code repository README's consistent for internal and external contributors_
---
## Prerequisites
_List any software, hardware, or skills required to utilize the solution._
* Prerequisite 1
* Prerequisite 2
* ...
---
## Quick Start
**[Link to Process Improvement Solution (template/code sample/tool/etc.)](#)**
_A brief description of what the link provides, e.g., "Click the link above to access the full template for the README.md file."_
---
## Step-by-Step Guide
1. **Step 1**: _Brief description of the step._
2. **Step 2**: _Brief description of the step._
3. ...
---
## Credits
**Authorship**:
- _List of contributing authors of this write-up who actually wrote words. Link to GitHub profiles if available, e.g. [Bugs Bunny](https://www.github.com/bbuny573429)_
**Acknowledgements**:
* Source/Organization 1 that inspired the solution or was adapted from
* Source/Organization 2 that inspired the solution or was adapted from
* ...
---
## Feedback and Contributions
We welcome feedback and contributions to help improve and grow this page. Please see our [contribution guidelines](https://nasa-ammos.github.io/slim/docs/contribute/contributing/).
jl-0
galenatjpl
jpl-jengelke
stirlingalgermissen
Checked for duplicates
Yes - I've already checked
Alternatives considered
Yes - and alternatives don't suffice
Related problems
Our SLIM guides vary considerably in terms of writing style, formatting, and the overall content and messaging communicated. For example, some guides are very succinct and some are very verbose. Some include clear steps and some do not. Some describe heritage and acknowledgements whereas some do not. It can be confusing for a reader of the SLIM website to scan through process improvements that are communicated in such different styles and language.
Describe the feature request
Let's come up with a standard template for our SLIM guides that we can use for both future contributors to follow as well as for us to rewrite existing guides for.
Some of the key things I think are needed are: