Sejal Parikh
  • Member for 4 years
  • Last seen more than 3 years ago
What are standard techniques that indicate to the documentation reader that they are to substitute their own appropriate text (e.g. username, domain)?
4 votes

I prefer angular brackets <> and hyphenated text inside. For example: URL format: http://<your-host-name>:<your-port-number>.com/ The text should be something that would make it ...

View answer
How to make documentation accessible to vision-impaired audiences?
4 votes

Accessibility in writing is a widely discussed issue and there are a number of resources available on this. Vision impaired people generally use screen readers such as JAWs to "read" documentation. So,...

View answer
Should beta functionality be mentioned in a training manual?
0 votes

I would keep a universal training manual for all types of end users to avoid worrying about a maintaining separate content for beta and non-beta users when your product goes live and no more beta. ...

View answer