[Swift-devel] Swift Documentation Platform

[Ketan Maheshwari]

Hi,

While we close in on a decision, I am writing this as an observation to the ongoing discussion about Swift Documentation Platform. And some thoughts in the end.

As of now we have a Main, existing Swift Documentation page:

[1] http://www.ci.uchicago.edu/swift/docs/index.php

In addition, we have pages on CI wiki related to Swift documentations:


[2] http://www.ci.uchicago.edu/wiki/bin/view/SWFT/WebHome

The above link contains many useful but semi-complete/unrounded pages on cookbooks, tutorials and may technical notes.


We have a page on cog wiki dedicated to Coasters:

[3] http://wiki.cogkit.org/wiki/Coasters

The pictures are very neat but slightly outdated and needs update. More pictures would also be required in my opinion to explain several of the relatively new coasters concepts.


We have google sites whose contents overlap with [1] , likely that it is completely redundant to [1]

[4] https://sites.google.com/site/swiftguide/home


A wealth of information about Swift techniques, examples, issues, notes and ideas are living on the following:
[5] https://bugzilla.mcs.anl.gov/swift/

[6] mail.ci.uchicago.edu/pipermail/swift-user

[7] http://mail.ci.uchicago.edu/pipermail/swift-devel/

[8] Mike's Swift Notes (As an attached doc)
-------------- next part --------------
A non-text attachment was scrubbed...
Name: Notes.SwiftUsage.doc
Type: application/msword
Size: 212480 bytes
Desc: not available
URL: <http://lists.mcs.anl.gov/pipermail/swift-devel/attachments/20110401/c2a3dec5/attachment.doc>
-------------- next part --------------


[9] \O/  <--- Mihael's head .............................................. (kidding Mihael)



This really calls for some kind of massive distillation and unification effort. Ideally we want *only* one place where all the information resides that a user wants to know.

Things could be hyperlinked to some extent but it has its own harms. A simple, serial, low-branched documentation would be ideal in my opinion.

I am, at the moment putting some energy into the above and trying to think on structuring my efforts which I am finding a bit overwhelming.

May I have your valuable suggestions on what would be a super master stroke strategy that could gather all these scattered gems into one nice place.

Thanks for reading this long and a bit rantish mail and putting on your ideas.


Cheers,
Ketan