Last week I went to Devoxx Belgium and I learned something new: 7 tips to write more fluently. These tips can be applied on documentation, blogs, and even books. All things we as developers might some day need to write.
So let me please share the tips I learned from Dan Allen:
1. Write in plain text
Write using AsciiDoc or plain-text editor of your choice. This helps you to free your mind in the closest format to thought, plain text. This also helps you to keep a clean separation of content and presentation. So you can focus on content and get a beautiful result.
2. Answer a question
Dan talks about how most of us are ok with replying to e-mails. But when it comes to writing documentation or other long-form writing, we clam up.
So why not simply write as if you are answering a question? Start with an outline of questions and answer those questions, then go back and change those questions to statements in the final version.
The key is to get all the information out of your head and onto the page. You can organize and shape it later on.
Simply write one sentence per line like you do when writing code.
Dan mentions the following benefits:
- It feels natural (matches how we write code).
- It keeps changes localized (because edits do not cause reflow).
- It's easier to diff.
- You can easily rearrange or comment out sentences.
- You can add commentary at the sentence level.
- It encourages shorter sentences; edit with a knife!
4. Write in comments
Again something we do automatically in our code: writing comments. Once you write using Sentence-per-line, you can use line or block comments quite effectively to try out content, swapping it in and out of place. Comments give you some place to put ideas, notes, reminders, and drafts directly adjacent to the source.
5. Power thesaurus
Dan loves using a thesaurus. His favorite is Power Thesaurus. The thesaurus is a mediator between your unconscious and conscious. Your unconscious knows what it wants, but your conscious isn’t getting this information. The thesaurus is the secret to getting that information across the divide and onto the page.
6. Visualize progress
The hardest part about writing is getting started. Visualizing your progress can be very motivating. So make sure that you always have an up-to-date preview of your content available. It will help you keep the big picture throughout the writing process.
7. Couch read
Couch reading is the practice of reading your content away from your PC. Make yourself comfortable and read through your document on your phone or tablet. You'll be surprised about the amount of errors you'll discover. This works because it shifts your "locus of attention" to reading (and only reading).
And here is Dan's entire presentation straight from YouTube:
The full transcript is also available: 7 Ways to Hack Your Brain to Write Fluently: Transcript. Feel free to share your tips below in the comments or ping me on Twitter: @pvdevoor