Tag Info

Hot answers tagged

3

In the absence of a style guide saying otherwise, your approach is fine. (So is abbreviating to "Fig.", though I prefer to spend the extra three letters and use the full word. It's also consistent with "Table", which I haven't seen abbreviated as "Tab.".) Whatever you do, be consistent -- refer to all of your figures as "Figure N" and use that same text ...


2

I am just sharing the guidelines I work by. If required, we can discuss the reasoning behind these guidelines and may be even specific examples. (Say, for example, beyond maintainability, yet another reason text is better for less-than-complex steps is search engine optimization.) When to use screenshots? You need the context of the UI to make a targeted ...


1

I do not employ the technique but here are a few web links that I have found about the use of minimalism in technical writing: A discussion on the principles of minimalistic writing as described by Carroll http://everypageispageone.com/2013/07/02/what-is-minimalism/ A brief discussion by IBM: ...


1

This is a hard problem. Unless your company has the resources to do full reviews of all the documentation on each release -- and if they do, I wonder how they stay competitive -- then you are at risk here. In my experience you can do some things to address the problem when it happens, and some things to reduce its chance of occurring. Here are techniques ...



Only top voted, non community-wiki answers of a minimum length are eligible