"While haste and speed often get confused, they differ in that the second shows control instead of panic. You can maximize speed while keeping accuracy quite high; beyond a certain point, though, spending more time on accuracy, style, or other aspects that prevent a document from going live always yields diminishing returns.
Nobody reads perfect yet outdated docs, except historians. Even then, docs aren’t perfect, because documentation can’t ever be perfect. This is a key principle I stand by (call it the Ferri Paradox if you want): Any document describing a system is necessarily inaccurate. And yet, this reality doesn’t significantly alter the impact of our work, because we aim for simplicity and usefulness over extreme faithfulness. Given how imperfect products are, docs are a charitable portrait.
Now, how you write docs quickly depends on a number of factors. Some of those factors you can’t control: your overall amount of experience as a writer, your initial expertise with specific technologies, and the way features are developed and released in your organization. But other aspects are yours to act upon. For example, you can decide how to best use the technical resources at your disposal and how to approach writing the docs and asking for feedback."
Docs, l’éditeur de texte libre et collaboratif de La Suite numérique, a été reconnu "bien public numérique" (Digital Public Good) par la Digital Public Goods Alliance ce matin à l’ONU lors de la semaine Open Source des Nations Unies.
Run you own Docs : l'éditeur de texte collaboratif où la forme n'est plus un sujet
Email @inlinestyle.it
Fediverse Video & Music
Photos library
Cloud games
Projects and Tasks
Personal website
