...
- Team agrees that the three main guidelines should be:
- Documentation and code must be kept in sync
- Major sections should be focussed on different types of users: tutorials ("getting started"), reference, cookbook, general docs
- WebWork documentation should be core focus, with XWork documentation being included in the WebWork docs where possible.
- Implementation strategies for these guidelines are:
- Code/docs sync: utilize the Confluence snippet macro. We may need Atlassian to help get this macro in to shape.
- Sections: each person in the meeting will write their own TOC and present it next week - see 06-15-2005 TOC Homework
- Standaline WebWork docs: we will utilize the {include} macro to include whole XWork pages when possible, but we will avoid linking to the XWork docs.
...