hackforla / hackforla/knowledgebase-content

Create a Guide/Template: How to Peer Review a Draft Guide

Aperta
#146 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Complexity: Missing CoP label: checked CoP label: shortcuts added CoP: Admin CoP: Content CoP: Data Science CoP: Design CoP: Engineering CoP: Marketing CoP: Ops CoP: Product CoP: Revenue CoP: UI/UX Research Phase: 1 - Gather Examples Solo size: missing status: 1.1 needs wiki examples status: 1.2 needs issues examples status: 1.3 needs project board examples status: 1.4 needs slack examples
Lingua principale
Nessun dato sulla lingua
Stelle
2
Fork
1
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

### Overview
We need to create a guide on how to peer review a draft guide once the draft is complete.

### Action Items
The phases in the guide-making process are listed below. Each phase displayed in blue is linked to a wiki page with instructions on how to complete that phase. Open the wiki page in a new tab, copy the instructions for each part into the section labelled 'Tasks' at the bottom of this issue, and complete each task listed.
- [ ] [Create a Guide Draft](https://github.com/hackforla/guides/wiki/How-to-Draft-a-Guide)
- [ ] If needed, create a template
- [ ] [Have your guide peer reviewed](https://github.com/hackforla/guides/wiki/Peer-Reviews-for-Guides)
- [ ] [Present your guide for leadership review](https://github.com/hackforla/guides/wiki/Submitting-Your-Guide-for-Leadership-Review)
### Resources/Instructions
- Google Drive Folder for this Guide’s documents and shortcuts (to documents in other locations) [0146 [DRAFT] How to Peer Review a Draft Guide ](https://drive.google.com/drive/folders/1jYhlgXAo-cF0jByh4hbfS0ryt69WmrGU)

- https://github.com/hackforla/knowledgebase-content/issues/106
- this peer review guide needs to be in the format of a slide deck/Google Slides
- need to check for formatting issues (e.g. cover page title should be all capitalized)
- title of the guide needs to make sense
- peer reviewer will leave notes/comments on the draft guide for the assignee to review and fix
### Projects to Check
### Tasks
- [ ] This is where you will copy instructions from the wiki page for the step you are currently on.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia dalla pagina wiki „Peer Reviews for Guides“, dalla cartella Google Drive contenente la bozza della guida e dall’issue #106 di knowledgebase-content. Crea la guida come presentazione Google Slides, verificando i requisiti relativi al titolo e alla formattazione descritti nell’issue. Il lavoro è completato quando il processo di peer review e le note/i commenti della revisione sono documentati nella guida completata.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.