[wp-docs] Handling Version Differences in Documentation

Carthik Sharma carthik at gmail.com
Tue Aug 31 21:38:13 UTC 2004


We could just update the affected documents to make it clear that the
function has been discontinues, for example, though that is kind of
rare.
Notes describing variations with regards to versions should work fine.

Now when the UI changes, like from 1.2 to 1.3, then we might have to
start versioning UserManuals.

A UserManual is imaginary at this point, but yes, we'll have one
sometime, so maybe we can follow wikipideas example of doing
disamguation pages, with usermanual(_1.4) for example, which doesn't
show evidently, for example.

On Tue, 31 Aug 2004 17:01:33 -0400, Tor Bjornrud <bjornrud at msu.edu> wrote:
> 
> On Aug 31, 2004, at 4:03 PM, Matt Mullenweg wrote:
> 
> > Tor Bjornrud wrote:
> >
> >> Any thoughts on how we should handle the difference between WordPress
> >> versions in the docs?  For instance, the directions for
> >> "Customization" will be very different from one another depending on
> >> the version of WordPress the user is customizing.
> >
> > Codex is set to launch with 1.3, so all documentation on the new wiki
> > should be for 1.3. I've made a few edits to this effect as new
> > documents have come along.
> >
> > Reasonably I can't forsee our already overburdened documentation
> > effort maintaining versioned documentation at this point, so we should
> > probably try our best to keep everything current with the latest
> > release and address problems with older versions as they arise, all
> > the while encouraging people to upgrade.
> 
> If we only publish documentation for the latest release (I assume you
> mean official release, not cvs. Please correct me if I'm wrong), what
> do we do when we want to upgrade versions, start documentation for the
> new release after the code's released or something else?  I'm just of
> the mind that having the docs ready to go when the code is officially
> ready to go is a Good Thing(tm).
> 
> 
> 
> 
> _______________________________________________
> docs mailing list
> docs at wordpress.org
> http://wordpress.org/mailman/listinfo/docs_wordpress.org
> 


-- 
When nothing is done, nothing is left undone -- 老子 Lǎozi

University of Central Florida
Homepage: http://carthik.net



More information about the docs mailing list