hackforla / hackforla/knowledgebase-content

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

Offen
#146 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
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
Vorherrschende Sprache
Keine Sprachdaten
Sterne
2
Forks
1
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

### 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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit der Wiki-Seite „Peer Reviews for Guides“, dem Google-Drive-Ordner für den Entwurf des Leitfadens und dem Issue #106 von knowledgebase-content. Erstelle den Leitfaden als Google-Slides-Deck und überprüfe die im Issue beschriebenen Anforderungen an Titel und Formatierung. Als abgeschlossen gilt die Aufgabe, wenn der Peer-Review-Prozess sowie die Review-Notizen/-Kommentare im fertigen Leitfaden dokumentiert sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.