Victor Loux — bookmarks tagged “documentation”

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…

readme.so - Easiest Way to Create A README

readme.so/

Use readme.so's markdown editor and ready made templates to easily create a simple README for your repositories

The documentation system — Documentation system documentation

documentation.divio.com/

Media Manipulation Casebook

mediamanipulation.org/

Isoflow

isoflow.io/

How to Write Technical Posts (so people will read them) :: Reasonably Polymorphic

reasonablypolymorphic.com/blog/writing-technical-posts/

Help message for shell scripts — samizdat

samizdat.dev/help-message-for-shell-scripts/

Samizdat blog by Egor Kovetskiy

Encouraging a Culture of Written Communication – mcls

mcls.io/blog/encouraging-a-culture-of-written-communication

A practical guide to writing technical specs - Stack Overflow Blog

stackoverflow.blog/2020/04/06/a-practical-guide-to-writing-technical-specs/

Technical Writing | Google Developers

developers.google.com/tech-writing

Technical Writing Courses for Engineers

iHateRegex - regex cheatsheet for haters

ihateregex.io/

Stop hating regex and start learning. iHateRegex is a regex cheatsheet that also explains the commonly used expressions so that you understand it.

Infusion

thepaciellogroup.github.io/infusion/

Welcome to Infusion: a documentation builder for inclusive designers and those trying to be inclusive designers. These are Infusion’s docs, but they are also an example of a site built with Infusion. Here are some of its features: