Overall plan for content

[wragge]

The guide to Trove data will document in detail the types of content available through Trove, and what data is accessible for each content type. It will describe both the possibilities and limits of Trove data, enabling researchers to develop a critical understanding of Trove as a source for digital research. The guide could make use of existing resources such as the Trove Newspapers Data Dashboard and the GLAM Workbench. Ideally, it would be published using Jupyter Book to allow the embedding of live code and integration with the proposed Nectar Binder service.

• The guide will be presented in a narrative format with embedded visualisations, data previews, and code samples.
• Computationally generated content (such as visualisations) will be updated each time the guide is built.
• Content will be formatted as a series of reusable chunks to allow for easy integration into teaching or research training materials.
• Some content will be reused from existing GLAM Workbench notebooks.
• Admonitions and sidebars will be used to highlight problems, questions, solutions, and pathways – these will encourage users to think critically about Trove data, and provide links to additional tools and examples.
• Links will be available to run notebooks on Nectar Binder service

[wragge]

JB's own documentation guidelines cite the Diataxis Documentation Framework. It divides documentation into four categories:

• Tutorials
• How-to guides
• Explanation
• Documentation

I'm thinking that the main body of the TDG is a combination of Explanation/Documentation. The 'Pathways' would be tutorials. And 'How to' guides focused on specific tasks would be separate reusable chunks (that might live in the TDG or elsewhere such as the GLAM Workbench) and be linked from the main text (probably through admonitions).

[wragge]

Current list of chapters

• 8

• 9

• 10

• 28

• 11

• 12