Victor Loux — bookmarks tagged “documentation”

unpaper/unpaper: A post-processing tool for scanned sheets of paper.

github.com/unpaper/unpaper

technicalwriting.dev

technicalwriting.dev/index.html

Life Is Too Short to RTFM: How Users Relate to Documentation and Excess Features in Consumer Products | Interacting with Computers | Oxford Academic

academic.oup.com/iwc/article-abstract/28/1/27/2363584

An Engineer’s Best Tips for Writing Documentation Devs Love – The New Stack

thenewstack.io/an-engineers-best-tips-for-writing-documentation-devs-love/

Tools for a Culture of Writing

matt.blwt.io/post/tools-for-a-culture-of-writing/

A set of useful tools for cultivating a culture of writing, namely the RFC, the Decision Record and Decision Log, and the Pre-mortem/Prospective and Post-mortem/Retrospective

Developers spend most of their time figuring the system out

lepiter.io/feenk/developers-spend-most-of-their-time-figuri-9q25taswlbzjc5rsufndeu0py/

What does it mean when we say that developers spend most of their time figuring the system out? Why is it important? And how else could we look at this problem?

A Designer’s Guide to Documenting Accessibility & User Interactions by Stéphanie Walter

stephaniewalter.design/blog/a-designers-guide-to-documenting-accessibility-user-interactions/

Please put units in names

ruudvanasseldonk.com/2022/03/20/please-put-units-in-names

Using strong types, or putting units in names, is a small effort that can make a tremendous difference for code readability.

Introduction - Vim Reference Guide

learnbyexample.github.io/vim_reference/Introduction.html

Vim Reference Guide

Scaling the Practice of Architecture, Conversationally

martinfowler.com/articles/scaling-architecture-conversationally.html

GitLab Communication | GitLab

about.gitlab.com/handbook/communication/

The power of the design doc. How documenting our process has become… | by Brendan Fagan | Deliveroo Design | Medium

medium.com/deliveroo-design/the-power-of-the-design-doc-fbf5070163f8

Way back when I was in the midst of my graphic design degree, touching on everything from branding to “book-making” (that one was painful), there was always one thing expected from every student when…