News for hackers. Stuff that matters.
Re:Will StackOverflow Documentation Realize Its Lofty Goal? by akavel on Wednesday August 31, 2016 @01:02PM (#12399771)
After some initial thoughts and experimentation, I now look at the "SO Documentation" name as somewhat misleading (if "Documentation" is interpreted as "[Reference] Manuals"), and try to rename it in my mind as "StackOverflow HOWTOs" (or "Guides"). Then it starts to make more sense to me: as a collection of guides on how to work with various tools which have weird, irregular, messy API/UI (which was probably more grown than designed). Ones where a regular, exhaustive Reference Manual cannot be built along API/UI boundaries, as the boundaries are too chaotic, so a classic Reference Manual would be chaotic too. HOWTOs/Guides can then try to introduce some kind of desperate order in such mess, by focusing on some conceptual topics, while cross-cutting through the lines drawn in the API/UI.

Example tools for which I believe SO Docs can find success: vim, git, bash, Linux, emacs, maybe Nix tools+library+NixOS

Example tools/languages for which I (personally) believe SO Docs won't find success: Go standard library, MSDN, PHP standard library.

There are no comments on this comment yet.