gbdev/pandocs

LOW and HIGH terms might be confusing in SGB docs

Open

#375 aperta il 10 ott 2021

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Markdown (134 fork)auto 404
contentgood first issue

Metriche repository

Star
 (775 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

"LOW" and "HIGH" are used to refer to signals, but a software developer may not have the necessary background to understand what those mean. They should be at least explained in an info box at the top (as per the style guide), and maybe replaced throughout the document where it makes sense to do so.

Guida contributor

Direzione di ricerca
Esamina la guida di stile di pandocs per le convenzioni su come spiegare termini come LOW e HIGH. Identifica tutte le occorrenze nella documentazione in cui questi termini sono usati senza spiegazione. Aggiungi un riquadro informativo all'inizio di ogni sezione pertinente e sostituisci con terminologia più chiara dove appropriato.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75