User Guide Documentation Sprint for May 2023 Hackathon

Goals

• Create simple user guides to cover Hackathon tool install and workflow steps
• Create a sustainable documentation workflow process

Proposal

• Proposal: There would be two user manuals - 1. install and 2. Workflow
• Use Fidus Writer workflow and add additional output formats for content reuse (Markdown) and for DeepL multilingual translation.
  • Exampple guides:
    • https://nfdi4culture.github.io/automating-exhibition-catalogue-creation-guide/
    • https://mrchristian.github.io/guide-en/
• The sustainable documentation model will look at how to keep documentation updated, modular, and work as small volunteer work packages.
• Documentation will be created over the Hackathon - with first drafts available after the hackathon

Task areas

• Confirm that these are the steps that need documentation: https://semanticclimate.org/p/en/docs/
• Survey and collate links of existing content
• Create a work plan, and modularised tasks
• Create a writing style guide
• Implement semanticClimate styles for multiforat outputting
• Recruit teams for the hackathon: writers, editors, reviewers, testers, designers, css coders.

Action points

• Write very short announce as blogpost for site: SemCli Guides - documentation team call
• Create 2x repos on semanticclimate GitHub: Install Guide, and User Guide
• Setup doc templates and layout style in Fidus Writer
• Use channels #documentation on Slack and Discord
• Create ToC outline for both guides in consultation with team
• Locate and lists existing documentation links
• Source semClimate graphics resources
• Create writing and graphic style guide
• Creat workplan with modular tasks based on 2 hour work packages for volunteers
• Technical issue: How to move from Fidus markup: (JSON; HTML, LaTex) to Markdown and to forked multilingual translation.
• Use GitHub Project and Discussion
• Use a GitHub Contribute configuration