Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Chronologue docs: Overview of the recording process #21

Open
11 tasks
kickoke opened this issue Jun 30, 2022 · 0 comments
Open
11 tasks

Chronologue docs: Overview of the recording process #21

kickoke opened this issue Jun 30, 2022 · 0 comments
Assignees
@peterjurich
Labels
documentation Improvements or additions to documentation

Comments

@kickoke
Copy link
Collaborator

kickoke commented Jun 30, 2022

Summary

"Overview of the recording process" is a Concept that provides Scientists with details about the recording process.

Research

  • Determine user goals.
  • Determine prerequisites
  • Determine what steps the user has to take.

Writing/Testing

  • Create a new branch.
  • Create a draft.
  • Write a commentary in the document to highlight best practices.
  • Take feedback notes for the template group.
  • Create a PR.

Review

  • Grammatical review.
  • Technical review.

Publication

  • Merge PR to docs.

Resources

Source file: https://github.com/thegooddocsproject/chronologue/blob/docs/docs/chronologue/c_recording_process
Template: Explanation template
Feedback form: INSERT LINK
@kickoke kickoke added the documentation Improvements or additions to documentation label Jun 30, 2022
@kickoke kickoke changed the title Chronologue docs: Chronologue docs: Overview of the recording process Jul 6, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@peterjurich peterjurich

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kickoke @peterjurich