774834 - Improve "Using IndexedDB"

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: API: IndexedDB, defect)

Description

[Janet Swisher]

Capturing this from an email, so I don't lose it, and someone else can work on it if they want.

https://developer.mozilla.org/en/IndexedDB/Using_IndexedDB 

Problems:
* it doesn't describe a single, progressive example... it has bits and pieces and options, not a step-by-step set of instructions building up to a single working example; it's more like a long-form reference than a tutorial
* inconsistent code: each code block includes different variable names for the same object, or the same variable name with different scopes (global vs. function), which means you can't mix-n-match bits of code
* it doesn't include a link to a working example, so I could test it to see if it works at all
* there is no overarching theme ("in this tutorial we are building an app that uses IndexedDB to do X"); the HTML5Rocks article does that ("A simple TODO list using HTML5 IndexedDB"), adding consistent features as it progresses, and this is a nice, easy-to-follow format
** Note however that the HTML5Rocks article does has the minor flaws that the example DOESN'T WORK and ISN'T MARKED AS OUTDATED! (Come on, Google!)

Good things about it include
* It has pragmatic code examples, like
  var indexedDB = window.indexedDB
                || window.webkitIndexedDB
                || window.mozIndexedDB
                || window.msIndexedDB;
* For the includes Mozilla-specific methods, it calls them out explicitly, and explains why an extension was made (though it could do a bit better job of the explanation)
* Seems to hit the right points on what someone might want to do with IndexedDB (but again, not consistent with other code blocks in the same article)

One thing that would be better is to include a link to a working example right up at the top, so people can assure themselves that the article describes something that works, so it's a good investment of time to read it and tinker with the code.

Comment 1

[Janet Swisher]

Assigning to :cmills. If this is no longer relevant, just close it.