The trick to documenting complex technologies is not just to present the ideas clearly and make them sound simple. The trick, as with all writing, is to carefully consider the audience. Nuera Communication’s VoIP gateway was a large piece of complex hardware that was set up for operation through configuration software. The configuration software could be run over a network, so I decided to make one hardware manual and one software manual, on the assumption that the hardware and software might not be used in the same room–or even the same continent–or by the same people.
Click on the image below to download a twenty-page PDF sample of highlights from the ORCA GX-Series Gateway Software Manual that I wrote and typeset in Framemaker.
