# Documentation

## Wayne Boka

---

# What is Documentation?

From the Oxford English Dictionary:

> The written specification and instructions accompanying a product, especially a computer program or hardware.

---

#Why Should I Document?

- Defines WHAT the application should do and HOW to do it
- You are going to forget how things work
- Reading through the source code for an answer isn’t fun
- You’ll want to pass the application off to someone else
- Help your end users

---

#Documentation Methods

- Guided tour through your application
- Text files (Markdown, LaTeX)
- Printed documents
- PDFs
- Slide show
- Help text

---

#Good Practices

- DO create a useful and intuitive UX for your end users
- DO write in short, concise sentences
- DO explain features that are not obvious
- DO write for the user not the applications
- DO make it easy to find answers
- DO use pictures/images where appropriate
- DON’T rely on the end user actually reading it

---

#Writing Documentation

- Step by step instructions
- Explain what feature does and why
- Assume end user has no prior experience/knowledge of the - application
- Keep task steps simple and isolated
- Add pictures/images to help end users follow along

---

#Examples

- [Bootstrap 3](https://getbootstrap.com/docs/3.3/)
- [ColdFusion](https://helpx.adobe.com/support/coldfusion.html)
- [jQuery Validation](http://jqueryvalidation.org)

---

# Resources

- [Why is Documentation Extremely Important for Developers?](https://www.seguetech.com/why-is-documentation-extremely-important-for-developers/)
- [Real Users Don't Read the Manual](https://www.getopensocial.com/blog/community-management/real-users-dont-read-manuals)
- [Tips for Writing User Manuals](https://www.userfocus.co.uk/articles/usermanuals.html)

---

#Questions/Comments?

## 🙋‍♀️❓🙋‍♂️