I am going back through my software's documentation, begun in 2001 with the H&M beta, trying to clean-up old Windows 2000 screenshots and outdated and/or overly verbose topics, as well as trying to be more consistent.
My main conundrum has to do with links.
- 1. Suppose a topic mentions "macros" 4 times. Currently, I insert a link to the corresponding topic with the first occurrence of "macros". But, what should be done about the 3 other occurrences ? Leave them plain, make them italics, repeat the link 4 times ?
2. I also place some links in a "See also" section at the bottom of many topics. Is it OK to repeat in the "see also" section, some of the earlier links ?
3. Finally, the titles in the TOC have proper capitalization (eg. "The Main Window"), and for the moment, any links to such a TOC entry would also have its link capitalized. But I find that when there are many links in a topic, there is just too much caps everywhere. Should I make the text of the link un-capitalized (eg. "the main window") ?
Very best regards,