Hoppa till huvudinnehåll

5 tips för att strukturera din dokumentation

· 2 min att läsa
Ola Davidsson
Ola Davidsson
Docs Developer and Technical Writer

Att skapa en tydlig och användarvänlig dokumentation är avgörande för att dina användare ska hitta den information de behöver. Här är fem praktiska tips för hur du kan strukturera din Docusaurus-dokumentation.

1. Planera sidstrukturen innan du börjar​

Innan du börjar skriva din dokumentation är det viktigt att planera hur sidorna ska organiseras. Använd en logisk hierarki med kategorier och underkategorier för att guida användarna genom din dokumentation.

Exempel på struktur​

docs/
├── intro.md
├── installation.md
├── guides/
│   ├── getting-started.md
│   ├── advanced-configuration.md
└── api/
    ├── overview.md
    ├── endpoints.md

2. Använd sidopanelen effektivt​

Docusaurus gör det enkelt att skapa en sidopanel som automatiskt speglar strukturen på dina dokument. Använd sidebar.js för att definiera dina kategorier och säkerställ att navigeringen är intuitiv.

module.exports = {
  tutorialSidebar: [
    {
      type: 'category',
      label: 'Guider',
      items: ['intro', 'installation', 'guides/getting-started'],
    },
  ],
};

3. Skapa länkar mellan relaterade sidor​

För att förbättra navigeringen, använd interna länkar för att guida användarna till relaterade sidor. Detta är särskilt användbart för djupare ämnen.

För mer information, se vår [installationsguide](./installation.md).

4. Använd Admonitions för att framhäva viktig information​

Admonitions är perfekta för att uppmärksamma varningar, tips eller extra information. De gör dokumentationen mer läsbar och engagerande.

:::tip
Glöm inte att uppdatera dina API-nycklar regelbundet för ökad säkerhet.
:::
tips

Glöm inte att uppdatera dina API-nycklar regelbundet för ökad säkerhet.

5. Testa och förbättra navigeringen​

När din dokumentation är live, be användare att ge feedback på hur lätt det är att hitta information. Använd deras feedback för att justera strukturen.