Conoscenza Modelli HTML

Modelli HTML modificabili per la Knowledge Base

I modelli HTML per la Knowledge Base sono siti completi di assistenza e documentazione, forniti come file modificabili. La struttura delle pagine è molto simile a quella di qualsiasi altro sito, con una homepage, elenchi di categorie, pagine di articoli e un modulo di contatto. Ciò che cambia è il modo in cui vengono personalizzate, perché tutto risiede nel codice sorgente, dove lo sviluppatore modifica direttamente il markup, le classi e l'ordine dei blocchi.

Cosa include il download

I pacchetti variano, ma la maggior parte contiene molte più pagine:

1. Modelli di articoli e categorie da copiare per ogni nuova voce;

2. Elementi di navigazione come breadcrumb, barra laterale e indice;

3. Elementi interattivi come un campo di ricerca, una sezione FAQ a fisarmonica o sezioni a schede;

4. Un modulo di contatto o di richiesta assistenza che puoi indirizzare al tuo metodo di invio.

Verificare quali di questi elementi sono effettivamente presenti è il primo passo. Un campo di ricerca e un fisarmonica dipendono da script inclusi nel template, e un pacchetto senza di essi lascia a voi il compito di implementare tale comportamento.

Creare un altro articolo senza ricominciare da capo

L'aggiunta di una voce a un template già esistente di solito funziona così:

1. Copiare il file dell'articolo e sostituire il titolo, il corpo del testo e i link;

2. Aggiungere la voce all'elenco delle categorie e all'albero di navigazione;

3. Verificare che i breadcrumb e i link correlati puntino dove dovrebbero.

Questa procedura rimane breve solo finché lo schema è valido. Quando ogni procedura mantiene il titolo, i passaggi e i link correlati nello stesso ordine, un editor apre un file e sa dove cercare. Vale la pena esaminare i livelli di titolo che seguono il contenuto, gli elenchi per le procedure e i link per le voci correlate nella demo, poiché questa disposizione è quella che si eredita in ogni pagina copiata.

Schermate strette e materiale di riferimento denso

Gli articoli di riferimento contengono paragrafi lunghi, termini collegati e screenshot. Le tabelle e gli esempi di codice sono la parte più problematica perché non si adattano bene alle dimensioni dello schermo e di solito necessitano di un'area di scorrimento dedicata.

Le modalità responsive di Nicepage coprono un'ampia gamma di schermi, dai grandi desktop ai telefoni con visualizzazione verticale. Aprite la pagina di un articolo con la barra laterale e il campo di ricerca in queste modalità, poiché questi elementi vengono caricati per primi.

Prima di procedere con il commit, osservate tre aspetti della demo: il layout della pagina, l'organizzazione del codice sorgente una volta aperto il file e il comportamento dell'articolo su un telefono. Un pacchetto che soddisfa tutti e tre i requisiti vi permette di scrivere la documentazione anziché dover ricostruire l'intera struttura.