#123 – Create Great Documentation

In today’s episode we dive into documentation, its rules, ethics, best practices and some tools that help to get started.

Guests

• Omaima Khalil

• Mohammed Aboullaite

Notes

0:00:00 – Introduction and welcoming

0:01:30 – Guests Introduction

0:02:50 – What is Documentation? Why we need it?

0:05:51 – What are the types of Documentation you know?

0:10:01 – Who do we write documentation for?

0:15:35 – What makes good documentation?

0:20:34 – Ethics of documentation and rules to respect

0:24:31 – How do we structure our documentation?

0:53:07 – What types of documentation should focus on writing?

1:02:20 – Some tools you use to write or share documentation.

1:10:00 – Tips from guests.

1:14:00 – GeeksBlabla Giveaway.

1:17:45 – Geeksblabla Picks

1:29:18 – Conclusion

Links

• Technical Writing One introduction
• Bookstack
• Docusaurus

Prepared and Presented by

• Meriem Zaid