Nuggets of Wisdom
Series

Documentation Habits

In this series, I will be sharing my thoughts and ideas on steps that engineers can take to reduce friction and/or resistance to writing documentations.

Articles in this series

[DH] Keeping an organised inventory of annotated screenshots

Nov 16, 20243 min read

Always misplacing where you put those annotated screenshots? Use a slide deck to keep them centralised in 1 file! · Background Context A common knowledge...

[DH] Keeping an organised inventory of annotated screenshots

[DH] Converting Mermaid Diagrams to Image with mermaid-cli

Jul 31, 20242 min read

To convert Mermaid diagrams into images while retaining document structure using Mermaid-CLI. No more taking screenshot of the diagrams manually! ·...

[DH] Converting Mermaid Diagrams to Image with mermaid-cli

[DH] Manage Document Formats with Pandoc

May 22, 20244 min read

Using reference document to ensure consistency in styles such as font family and font size, caption placement · Previously... In my previous article in...

[DH] Manage Document Formats with Pandoc

[DH] Markdown: The Medium for Collaboration

May 22, 20243 min read

A means to encourage engineers to build notes using an external and reliable system to assist in their efforts in writing documentations. · Context As an...

[DH] Markdown: The Medium for Collaboration

md2pptx: Generating Powerpoint slides from Markdown

Apr 30, 20222 min read

Context Recently, I wrote about the use of Augeas augtool in automating configuration files. I have learnt of the tool md2pptx by Mr. Martin Packer...