Hacker News new | past | comments | ask | show | jobs | submit | jmalin's comments login

I'm a technical writer. The framework not only captures the modern thinking about documentation, it expands upon it by using a 2-dimensional approach. Nearly all TWs use a variation of this framework.


It's interesting to see how classic MSDN documentation from the 90s is structured quite literally like this.

- xxx: One to two paragraph introduction

- About xxx: Generally explanation

- Using xxx: A bunch of how-to's

- xxx Reference: (id.)

The Tutorials quadrant is notably (and noticeably) absent and is what was then supplied by so many other places.


Depends on the product and the competition.

If no other library suffices, then customers will use yours. But they'll hate you. Over time, they might stop using your other contributions, even if they don't have any other choice.

In other words, would better/faster/more easily modified code help? Sure, but let's not overstate its value. We've all used badly designed code before. /s


Consider applying for YC's Spring batch! Applications are open till Feb 11.

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

Search: