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.

[DH] Keeping an organised inventory of annotated screenshots
Always misplacing where you put those annotated screenshots? Use a slide deck to keep them centralised in 1 file!
Nov 16, 20243 min read30
[DH] Converting Mermaid Diagrams to Image with mermaid-cli
To convert Mermaid diagrams into images while retaining document structure using Mermaid-CLI. No more taking screenshot of the diagrams manually!
Jul 31, 20242 min read4.1K
[DH] Manage Document Formats with Pandoc
Using reference document to ensure consistency in styles such as font family and font size, caption placement
May 22, 20244 min read62
[DH] Markdown: The Medium for Collaboration
A means to encourage engineers to build notes using an external and reliable system to assist in their efforts in writing documentations.
May 22, 20243 min read31
md2pptx: Generating Powerpoint slides from Markdown
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 which is a Markdown to Powerpoint converter. I thought this would be a suitable piece to try out testi...
Apr 30, 20222 min read544

Command Palette