4 ms·
I don't find writing to be difficult, but I do find getting started to be hard. My technical writing could be so much better if I had a template to choose from
by jonnycoder 4y ago
I don't find writing to be difficult, but I do find getting started to be hard. My technical writing could be so much better if I had a template to choose from. The template would have all the headings and subheadings to get started.
Some examples of what I'm looking for might include:
* App/repo documentation for other developers to onboard (plus high level specs)
* Specific feature documentation and migration plan
* Technical post mortem documentation for a particular issue (focusing more on the technicals than a post mortem for management)
- cweagans 4y agoIt sounds like you are running into the same problem that I did, which is that I wanted a structure to fill out with info. Don't do that. IMO, it's the hardest possible way to go about writing anything non-trivial. Start writing in the middle of some random section in the middle of whatever you're trying to write. Jump around to different parts of the work if you get stuck. Edit it together at the end. You do not have to write from beginning to end in the same way that you don't sit down and write code from top to bottom. If you really need a prompt, resist the urge to create a hierarchy of headers to just fill out. Writing is not just filling out a form. Try brainstorming a list of questions that your writing needs to answer. This has the added benefit of being able to divide up the work: you just give other people specific questions to answer. Let them organize the writing how it makes the most sense.