Hacker News new | ask | show | jobs
by lamontcg 781 days ago
> Technical writers: documentation by example is good only for newbies skimming through. People familiar with your product need a reference and exhaustive lists, not explanation for different fields spread over 10 tutorial pages. Focus on those that use the product day in and day out, not solely on the "onboarding" procedure.

You really need at least three documentation targets:

- onboarding the newbies workflows/tutorials - intermediate "focus on the important bits" workflows/tutorials - exhaustive references

There might be other useful ones as well, but I never see those three hit at the same time adequately.