Reply to post: Basic rules of documentation

First-day-on-the-job dev: I accidentally nuked production database, was instantly fired

Anonymous Coward
FAIL

Basic rules of documentation

Does it explain clearly what is required?

Are any steps where reader specific inputs are defaulted to safe varible e,.g. Enter your details as /<servername>/<yourname>

Can a person not familiar with the system, carry out the commands. If not, is a warning clearly visible?

POST COMMENT House rules

Not a member of The Register? Create a new account here.

  • Enter your comment

  • Add an icon

Anonymous cowards cannot choose their icon

SUBSCRIBE TO OUR WEEKLY TECH NEWSLETTER

Biting the hand that feeds IT © 1998–2020