The Trivium of Technical Writing #20
Description
The trivium of technical writing
Code/Content/Diagrams
See the triangle: diagram/content/code
Not suggesting a curry-Howard correspondence but a meaningful continuum.
We are made for image recognition. The memory master leverage cognitive cathedrals to retain large amounts of information. Even some programming languages are introducing this correspondence: https://ballerina.io/
Content as "wet code" and code as "dry code": http://unenumerated.blogspot.com/2006/11/wet-code-and-dry.html
Content/code is a continuum, not binary. The code should be self-documenting and content should be precise enough to be formally modeled to some extent.
On the idea that code/content as a continuum:
- https://meta.wikimedia.org/wiki/Abstract_Wikipedia/July_2020_announcement
- https://www.inklestudios.com/ink/
- https://en.wikipedia.org/wiki/AI_Dungeon_2
- https://beta.openai.com/
Authoring or writing as "development" and publication as "deployment"
Importance of written communication
- Written communication is remote work superpower
- Why writing matters in remote work
- 👆 The above post got amplified right on up to Chris Coyier
Notes to touch on:
Some notes on recent pattern changes and advances:
- Github as social network: https://i.imgur.com/X7mhZ1E.jpg
- A review of the vision: natural language to format language is a spectrum, not binary.
- Version control as the single resource of truth. GitOps
