Advent of Technical Writing: Placeholders

In this post, the author shares a trick they use while writing technical documentation to stay focused on writing instead of getting distracted by finding appropriate graphics or code snippets. They use placeholder values such as [add image] or [add code] when they don’t have the actual assets at hand or when the asset type isn’t supported in their writing tool. This allows them to complete their first draft and then easily search for these placeholders to make necessary changes. The author suggests that this “quick trick” might be helpful to others as well. They also caution to always double-check and remove placeholders before finalizing the work.

https://jamesg.blog/2023/12/12/technical-writing-placeholders/

To top