On 02/14/10 20:46, Claire Wood wrote:
Hi
I wonder if I can ask some advice. I'd like to have a go at
documenting the Calc/API stuff on the Documentation/Needwork Wiki page
if no-one else gets there before me and after I've done as much of the
Getting Started Wiki Guide as I can before I go away next week, but
not sure where to start to learn about the API's. It's been a while
since I documented any programming so will probably need to learn from
scratch again. Any tips on where I could start?
That's an ambitious project :-)
Basically the Calc section of the Wiki is written by developers (usually
non-native English speakers, which shows in the grammar etc.) for
developers. The Doc Team hasn't touched that part of the Wiki.
If I was to work on it I'd probably take it in bits, starting with a
simple language cleanup, correcting the grammar and wording. That will
give you a feel for what is involved in the API side of the docs, and it
will make what is documented there a lot more usable and readable.
From there, I think the complexity rises quite a bit. There is a
similar/parallel document called the Developer's Guide you can find
here:
http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OpenOffice.org_Developers_Guide
with a chapter dedicated to Calc:
http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Spreadsheet_Documents
Working along-side the developers (you can find them lurking on the
d...@api.openoffice.org mailing list) we could look at how the two
sections could be merged into one document (into the Spreadsheets
chapter in the Dev Guide).
C.
--
Clayton Cornell ccorn...@openoffice.org
OpenOffice.org Documentation Project co-lead
Sun Microsystems, Hamburg, Germany
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@documentation.openoffice.org
For additional commands, e-mail: dev-h...@documentation.openoffice.org
