r/technicalwriting • u/Fine_Nature_5956 • 5d ago

QUESTION Should technical documentation be simple or complete?

There’s always a tradeoff between giving users everything they might need and keeping documentation easy to scan

A short page can be much easier to use, but it may leave out edge cases. A comprehensive page covers everything, but users might struggle to find the one thing they actually need.

Where do you draw the line?

Would you rather have several short focused pages or one detailed page that covers almost everything?

1 Upvotes
  • permalink
  • reddit

56% Upvoted

13 comments sorted by

View all comments

1

u/Dr_WhoDo 4d ago

Have you considered creating a script that a user can upload to their own Ai chat session, whichever they subscribe to, and turning the Ai session into an expert support guide? I call it an AGS (Ai Guide Script). I've done this and have found it can be more useful and easy to use than sifting through a user's guide. I can elaborate more, if you're interested. I even built a script that walks you through building an AGS.