---
icon: lucide/file-pen-line
tags:
  - Community
---

<!-- SPDX-FileCopyrightText: 2026 PythonWoods <dev@pythonwoods.dev> -->
<!-- SPDX-License-Identifier: Apache-2.0 -->

# Problemi nella Documentazione

La nostra documentazione include informazioni esaustive su funzionalità, configurazioni
e molto altro. Se hai trovato un'incongruenza o vedi margini di miglioramento, segui
questa guida per inviare un'issue nel nostro [issue tracker].

  [issue tracker]: https://github.com/PythonWoods/zenzic/issues

## Template dell'issue

Segnalare un problema nella documentazione è generalmente meno impegnativo che segnalare
un bug, poiché non abbiamo bisogno di una riproduzione. Il nostro template è composto
dalle seguenti sezioni:

- [Titolo]
- [Descrizione]
- [Link correlati]
- [Modifica proposta] <small>opzionale</small>
- [Checklist]

  [Titolo]: #titolo
  [Descrizione]: #descrizione
  [Link correlati]: #link-correlati
  [Modifica proposta]: #modifica-proposta
  [Checklist]: #checklist

### Titolo

Un buon titolo dovrebbe essere una breve descrizione in una frase dell'issue,
contenente tutte le informazioni e le parole chiave rilevanti per semplificare
la ricerca nel nostro issue tracker.

### Descrizione

Fornisci un riassunto chiaro e conciso dell'incongruenza o del problema riscontrato.
Spiega perché pensi che la documentazione debba essere modificata e descrivi la
gravità del problema:

- __Sii breve__ — una o due frasi è l'ideale.

- __Un problema alla volta__ — crea issue separate per incongruenze non correlate.

> __Perché ne abbiamo bisogno__: descrivere chiaramente il problema è un prerequisito
> per migliorare la nostra documentazione.

### Link correlati

Condividi il link alla sezione specifica della documentazione che necessita di
modifica, e qualsiasi altra sezione correlata. Usa link permanenti (anchor link)
dove possibile.

> __Perché ne abbiamo bisogno__: i link ci aiutano a capire quali sezioni devono
> essere modificate, estese o rielaborate.

### Modifica proposta <small>opzionale</small> { #modifica-proposta }

Puoi aiutarci proponendo un miglioramento — idee approssimative o proposte concrete
sono entrambe benvenute. Questo campo è opzionale ma di grande valore.

> __Perché ne abbiamo bisogno__: le proposte di miglioramento beneficiano altri
> utenti che incontrano lo stesso problema prima che noi maintainer possiamo
> aggiornare la documentazione.

### Checklist

Grazie per aver seguito la guida e aver fornito un feedback prezioso per la nostra
documentazione. La checklist assicura che tu abbia letto questa guida e ci abbia
fornito tutto il necessario per migliorarla.

__Pensiamo a tutto noi.__
