Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

As a practicing technical writer I can testify that these content types are a common way to organize your documentation collection and identify gaps.

It’s a useful exercise to list each doc as a row in a spreadsheet, and then mark whether each doc is a tutorial, guide, conceptual overview, or reference, or a confused combination. Many times you’ll see that you have explained how feature A works but have no tutorial that shows how to use feature A, or vice versa.



As an OSS author this is very interesting, could you share more info or references about this please?

Also I'm curious, how do you become a technical writter? Does it involve writing articles/blogposts/etc to promote the project?



*writer

;-P




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: