Back to the future: the story of Squeak, a practical Smalltalk written in itself [pdf] (1997)
http://www.vpri.org/pdf/tr1997001_backto.pdf
#HackerNews #BackToTheFuture #Squeak #Smalltalk #ProgrammingHistory #TechDocs #1997
Back to the future: the story of Squeak, a practical Smalltalk written in itself [pdf] (1997)
http://www.vpri.org/pdf/tr1997001_backto.pdf
#HackerNews #BackToTheFuture #Squeak #Smalltalk #ProgrammingHistory #TechDocs #1997
Just come across this nice vid that introduces the DiΓ‘taxis approach to #TechDocs. I'd always thought it looked cool was but unsure what it meant.
#TechnicalWriting #Docum
entation
https://youtu.be/t4vKPhjcMZg?si=qKVVM2zluXQyOYS5
See also https://diataxis.fr/
Decided to try some lip sync animation for this short on the use of weak verbs in your documents.
Addressing critical needs driven by the dynamic world of #techDocs, Manny Silva has created Docs as Tests, a system that integrates well-developed #techComms practices and a collection of engineering tooling to help #technicalWriters streamline and constantly improve their software #documentation and #QA work.
This was a fun chat with a deeply experienced Silicon Valley #content veteran. I hope you enjoy the conversation as much as I did.
Min.js Style Compression of Tech Docs for LLM Context
https://github.com/marv1nnnnn/llm-min.txt
#HackerNews #MinJS #Compression #TechDocs #LLM #Context #GitHub
The good news - software engineers know how to do these things, or can find help along the way!
My thoughts in detail here: https://adambkaplan.com/post/2025-03-15-docs-software-problem/
#documentation #opensource #writing #blog #techdocs
/end
To get our docs quality to match our code quality, we need to treat our documentation as a software design problem. Just like our code, we need to write documentation with clear goals of what problems we are trying to solve (and for whom!), a vision for our ideal end state, an understanding of the tools at our disposal, and a plan to organize our ideas.
#documentation #opensource #techdocs
/3
It is not surprising that most of the "bad docs" are maintained by software engineers, and unfortunately we do not apply the same rigor to our documentation as we do to our code.
#documentation #opensource #techdocs
/2