9 ms·
There's nothing like writing up an Evernote or Wiki article on some feature, process, or how/why something works... and then nobody on the team ever reading. I
by bluedino 9y ago
There's nothing like writing up an Evernote or Wiki article on some feature, process, or how/why something works... and then nobody on the team ever reading.
I love writing documentation from time to time. But this helps by getting you to write documentation for only things people are asking about.
- tootie 9y agoI think the win would be in making the answers more findable. Confluence is great for writing documents and laying out pages in a hierarchy, but full-text search is still very hit and miss. Especially when you have 50 projects that all have the same keywords and 49 of them are irrelevant.
- gregmac 9y agoOr one person calls it "SomeTitle" and someone else only uses "Some Title" and search has no concept those are the same thing.
- htaoerth29th 9y ago> Confluence is great for writing documents Citation needed. I use it almost daily and it's essentially write-only and pretty unusably so at that.
- falcor84 9y ago>> Confluence is great for writing documents >... it's essentially write-only Seems like there's no disagreement here :) Anyway, as I see it, as someone who has written quite enough if it, most software documentation is write-only 99% of the time; but it is occasionally very handy to have that documentation written by the original developers when shit really hits the fan.
- some_account 9y agoEven if they read, it gets old really fast usually and who have to update it? You. So now you have two problems :)
- mmsimanga 9y agoIt's surprising how long code lives. In most organisations I have worked in, companies talk of rewriting legacy code but very few of these projects replace the existing code. There was a front-page article on Cobol here of HN a couple of days ago. Management tends to be interested in new features and I have noticed there is always a reluctance to change something that is already working.
- colshrapnel 9y agoSO is bad with search, entirely giving it away for Google to find relevant answers. In a wiki, at least I can follow the structure to find relevant pages, but in the heap of badly phrased questions it will be a pain to find anything relevant. I love writing documentation too, but from years participating on Stack Overflow I found it most unreliable for the purpose. As I once quipped, "Imagine Wikipedia where there are several hundred articles on the New York city. And one that Google links first is copy-pasted from Encyclopedia Britannica, 1913. And every single day several kids from elementary school start a new one." SO is torn between essentially ambiguous goals, providing fast on-site answers and being a reusable knowledge base. And it's good with the latter only because of Google. Without Google it will be no better than fast on-site answers on Slack.
- cheath 9y agoSearch is something that (with the advent of Teams) we've been bolstering our investment in. We've updated to the most recent version of elastic (which unblocks us on a lot of improvements) and we have upgraded how we are indexing questions/answers for Teams. and most importantly, we will just be continuing to improve it - since now it's more critical than ever to be successful there. To your point though, it's the first time we've invested in search in...well, I don't know how long.
- colshrapnel 9y agoStack Overflow has very small experience with reusing the knowledge, aimed primarily at providing fast on-site answers, for questions too localized for reuse. I have doubts in its ability to provide a solid documentation base, given a flop it made of Documentation project. Wikipedia is a way better source of reusable knowledge than Stack Overflow, and for a reason.
- KajMagnus 9y agoI go to StackOverflow maybe 100 times more often, for coding related things, than to Wikipedia. Disagree that Wikipedia would be better — when it comes to softw dev.
- soneca 9y ago"Documentation on-demand" seems a great solution indeed! Although $5/month per user is not cheap. I work at a medium-sized funded startup and I doubt it would be approved for overall use (as it would be nice to include other teams as well, like Marketing, Analytics, Customer Support). It is the same price of GSuite, that adds a ton more value than SO for Teams could ever add.
- jonhmchan 9y agoSO dev here. Not sure your size, but your first 10 users are much cheaper. On signup, it starts at $10/month and includes the first 10 users. It's $5/user/mo after that. If you're much larger than 10 - creeping into the 200+ people, it might be better to go with Enterprise: https://stackoverflow.com/enterprise https://stackoverflow.com/enterprise
- soneca 9y agoThanks for commenting. We are 50 devs and it would be useful to have around more 50~100 in it. I always have the impression that "Enterprise" plans are more expensive, but probably is just a misconception of mine.
- Binarytales 9y agoYou should maybe talk with your sales team? I work for a 200+ organisation (430ish) and was told we are too small for StackOverflow Enterprise
- coryfklein 9y agoI just figured this out, but that's $5/month for _active_ users. So if you don't use it, you don't pay for it. Not exactly sure what counts as an "active" user though.
- coryfklein 9y agoAh, turns out that's just another word for "users". [1] https://meta.stackoverflow.com/a/367268/446554 https://meta.stackoverflow.com/a/367268/446554
- klenwell 9y agoThis is where the rule of threes is useful for me. The third time I find myself answering the same question for someone, I'll make sure it get put in the wiki. Then next time I get asked, I just give the asker the URL. Saves time and breath. Also serves as a mini-tutorial on the utility of the wiki.