Timeline for answer to Warlords of Documentation: A Proposed Expansion of Stack Overflow by Ross Ridge
Current License: CC BY-SA 3.0
Post Revisions
7 events
| when toggle format | what | by | license | comment | |
|---|---|---|---|---|---|
| Mar 20, 2017 at 10:32 | history | edited | CommunityBot |
replaced http://meta.stackexchange.com/ with https://meta.stackexchange.com/
|
|
| Sep 10, 2015 at 0:17 | comment | added | Mikl |
@KevinMontrose For me, the silver bullet for overcome versioning problem is providing the full environment specification for each code example (it can be hidden under some Env icon in the corner of code snippet block and pops up when it clicked), go further if it will be integrated with auto testing platform we can have results without time wasting (it can be hidden under some Test Result icon), for that test suite need to be done. And more, we can give full environment snapshot (system image) to instant run with one click (docker containers can do this magic)
|
|
| Sep 7, 2015 at 13:28 | comment | added | bully | Versioning: I totally agree that there should be a handy mechanism for both, see for which target version a doc is handy as well as for 'marking' the right version while providing such a snippet. This discussion here reminds me pretty much of the Postgres documentation. What I like there is that the pages of a 'topic' (e.g. SELECT) stay the same but you can easily navigate to your specific target version. With this in mind, on SO, there are many answers for Postgres query questions telling 'this example is valid for PG < 8.1, for > 8.1 better use ...'. Maybe this could be some inspiration? | |
| Sep 4, 2015 at 5:09 | comment | added | TonyG | I've often thought that online documentation should be like CSS, or derived classes, with a baseline set of facts as paragraphs, then a superset which is overlaid upon that superset. So the base text shows through unless it's been superseded by later information. To see older info just peel back a layer (casting?) where some of the baseline may peek through or a prior version might still overlay that. Then in SO fashion or like a wiki, in one "view" each layer gets peer reviewed, upvoted, and edited, while in a more "consumer-oriented view" the doc is just readable as any other flat text. | |
| Sep 1, 2015 at 15:28 | comment | added | Kevin Montrose StaffMod | We have some thoughts on versioning. They're less complete than some of what's presented here (and everything presented here can still change), but the gist is "master version table for each tag, every Topic has a list of versions it applies to, within in each Topic you can further mark individual block as applying to particular versions, when a new version is released we infer [heuristic TBD] which pages get it outmagically." This will let us handle searching for versions, and let us do things like "when this version was added, what was the state of this Topic page." | |
| Sep 1, 2015 at 8:11 | comment | added | Jo Douglass | How about a version tagging system? Topics which were correct and relevant in multiple versions of a language could be tagged with all of them. When a new version came out, all topics could be flagged as needing checking to see whether they could be tagged with the new version or not. | |
| Aug 31, 2015 at 19:56 | history | answered | Ross Ridge | CC BY-SA 3.0 |