Miguel Afonso Caetano"Errors in content, especially technical documentation, lead to mistrust. When you write a piece of content, consider the future of the content.
The future of the content depends on the purpose and type of content that you’re writing. This list contains some common expectations that readers might have about various content types:
- A blog post has a date stamp and isn’t kept continually updated.
- Technical documentation always matches the product version that it references.
- Architecture documents reflect the current state of the microservice architecture.
- An email gets the point across and can’t be edited after you send it.
You must consider the future and maintenance of any content that you write if your readers expect it to be kept up-to-date. To figure out how difficult maintaining your content will be, you can ask yourself these questions:
- How frequently does the thing I’m writing about change?
- How reliable does my content need to be?
- How quickly does my content need to be accurate (e.g., after a product release)?
By answering these questions, you can then make decisions about how you write your content.
- What level of detail will you include in your content?
- Will you focus your efforts on accuracy, speed, or content coverage?
- Do you want to include high-fidelity screenshots, gifs, or complex diagrams?
- Do you want to automate any part of your content creation?
- Who will review your content? How quickly and thoroughly will they review it?"
https://thisisimportant.net/posts/how-can-i-get-better-at-writing/
#TechnicalWriting #TechnicalCommunication #ProfessionalWriting #SoftwareDocumentation #InformationArchitecture
How can I get better at writing?
As a professional writer, I frequently get asked, “as a ______, how can I get better at writing?” I’ve never had a good list of resources to point people to, so I finally decided to write one. I’ve worked hard to become a good writer, and I’ve had the privilege of many good teachers along the way. If you’re not really sure why your writing isn’t as good as you want it to be, that’s okay.
Creative Course
Career Reload
Adrie van der Luijt
ScriptaPerfecta
seyifulfilled
Monica C Miller
Oleksandr (Alex) Danylenko
