Documentation === Code

About Me

Eddie Jaoude

Passionate for #opensource #remote #inclusion

• youtube.com/eddiejaoude
• github.com/eddiejaoude
• twitter.com/eddiejaoude
• instagram.com/eddiejaoude

Overview

• Why is documentation forgotten
• Documentation should be treated like code
• Tools that can help us like Asciidocs & AsciiDoctor
• Example project

Questions / Translations

Pleae ask as we go along

Problem

						c = a + b // b is added to a
						

Solution

							| Tables        | Are           | Cool  |
							| ------------- |:-------------:| -----:|
							| col 3 is      | right-aligned | $1600 |
							| col 2 is      | centered      |   $12 |
							| zebra stripes | are neat      |    $1 |
						

							.Table Title
							|===
							|Name of Column 1 |Name of Column 2 |Name of Column 3

							|Cell in column 1, row 1
							|Cell in column 2, row 1
							|Cell in column 3, row 1

							|Cell in column 1, row 2
							|Cell in column 2, row 2
							|Cell in column 3, row 2
							|===
						

							sequenceDiagram
								participant Alice
								participant Bob
								Alice->>John: Hello John, how are you?
								loop Healthcheck
									John->>John: Fight against hypochondria
								end
								Note right of John: Rational thoughts
prevail...
								John-->>Alice: Great!
								John->>Bob: How about you?
								Bob-->>John: Jolly good!
						

Conclusion