UNPLANNED_USER_DOC_STRUCTURE_R0

[deyan]

UNPLANNED_USER_DOC_STRUCTURE_R0

[dan visel]

Documentation structure will start off using the hierarchy of the Sophie 1.0 documentation (see table of contents on page 2 of ​http://sophieproject.cntv.usc.edu/files/SophieHelp1.0.3.pdf ) but in wiki form.

[kyli]

2p. Reason: All but the last sentence from the overview is rather part of the design (the design should answer the question "how to make the concrete structure"). I think the last sentence in the overview is enough (the one sentence just before it should also go in the overview). The implementation idea should not be exactly the same as the implementation, since it is supposed to be written before that. My suggestion is to write just the idea of using Sophie1's documentation.
Please, take a look at the TicketQuery statement at the beginning of the page. You should include these statistics in every task you do. Just one more thing, do not forget to fill in the "Change properties" fields for the tasks :)

[danvisel]

I've gone through & fixed things - is this okay now?

[deyan]

Analysis is OK, dan, please rename the pages from UNPLANNED_USER_DOC_STRUCTURE_R0_Outline to UNPLANNED_USER_DOC_STRUCTURE_R0/Outline (in Implementation phase)

[deyan]

Analysis is OK, dan, please rename the pages from UNPLANNED_USER_DOC_STRUCTURE_R0_Outline to UNPLANNED_USER_DOC_STRUCTURE_R0/Outline (in Implementation phase)

[deyan]

took ownership by mistake

[danvisel]

Renamed the pages - sorry about that!

[pap]

It's generally OK but

• You could format with bullets. It makes the text a bit better readble
• I suppose some better organisation can be made in the Style guide. I think that some of the underscores could be changed to slashes, thus making some hierarchical structure. Of course this should be better thought about.
• I hope you'll add more style rules in the implementation phase

[danvisel]

I've implemented this structure for ITERATION_03/Release/UserDocumentation; changes were made to page-naming conventions at Pap's request, and I've reformatted the documents.

[pap]

What's written in UNPLANNED_USER_DOC_STRUCTURE/StyleGuide is not correct. I mean the naming convention. You should correct these.

[danvisel]

I've reworked this - funny, I thought I'd reworked the style guide's naming convention, maybe it didn't save correctly. Okay now?

[pap]

Well done.
We could reconsider the placement of the user documentation in the next revision. I think it'd be better if we define a centralised place for the documents and just update them whenever there is need.

[danvisel]

I agree with this - I don't know if it makes sense to duplicate all the pages every time. It would make more sense to keep them in one place, link to that, and update them when needed.

[deyan]

Batch update from file query-obsoleted.csv