Skip to content

Latest commit

 

History

History
33 lines (19 loc) · 650 Bytes

how-to-doc-template.md

File metadata and controls

33 lines (19 loc) · 650 Bytes
id
how-to-doc-template.md

Template for How-to Docs (State an Actionable Goal for the user)

Please describe the instructive goal you expect to achieve and preparation/prerequisites that involved.

Step 1 - Use second-person imperative to state the operation

Add detailed description when necessary.

Check previous user guides for cohesion in code sample  .
Aim for utility and simplicity when adding code/example  .

Step 2 - Use clear and concise words in title and steps

Use hyperlink to cite long references.

# Add comment(s) on code when needed
this is code  .

Step 3 -

...