qlyoung's wiki

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
documentation [2026/02/12 01:56] – [Tools] sentence qlyoungdocumentation [2026/02/12 17:05] (current) – [Tools] promote heading one level qlyoung
Line 48: Line 48:
   - If you want to write code - I feel for you. Don't you want people to use that code?   - If you want to write code - I feel for you. Don't you want people to use that code?
  
-The last point brings up an important point - if you have zero interest or responsibility for anyone else to use what you're writing, by all means, do not write docs if you don't want to. I am not saying that you need to document everything you make. But for things you intend other people to use, writing docs will make them love you. If you do it professionally, I will double down and claim that competency in technical writing is part of being a well rounded and competent engineer.+The last point is important - if you have zero interest or responsibility for anyone else to use what you're writing, by all means, do not write docs if you don't want to. I am not saying that you need to document everything you make. But for things you intend other people to use, writing docs will make them love you. If you do it professionally, I will double down and claim that competency in technical writing is part of being a well rounded and competent engineer.
  
 ===== culture ===== ===== culture =====
Line 74: Line 74:
 Now the user has that docs page to share with anyone facing the same problem and KP can spend less time answering that question in the future. This saves everybody time and improves morale. Now the user has that docs page to share with anyone facing the same problem and KP can spend less time answering that question in the future. This saves everybody time and improves morale.
  
-==== Tools ====+===== tools =====
  
 I'm not going to talk about what docs tools I like here. Actually I am going to talk about the opposite. I'm not going to talk about what docs tools I like here. Actually I am going to talk about the opposite.
Panorama theme by desbest
documentation.1770861412.txt.gz · Last modified: by qlyoung
CC Attribution-Noncommercial-Share Alike 4.0 International Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International