Allmänna tips

Det här avsnittet innehåller några allmänna tips.

Namngivningen av filer

Reglemente

Inga blanksteg eller skiljetecken. Använd bindestreck för att avgränsa orden i filnamnet.
Använd alla gemener.
Högst 80 tecken - det här är en förlagssystemgräns.
Använd åtgärdsverb som är specifika som att utveckla, köpa, bygga, felsöka. Inga ord.
Inga små ord - inkludera inte a, och, in, eller etc.
Alla filer måste vara i markdown och använda .md filändelsen.

[! NOT]Namnen på mappstrukturen, filerna, bilderna och videorna måste vara på engelska.

Exempel

Ämnesrubrik	Namnge
Välj ett företag	ui-how-select-company.md
Ange villkor i filter	ui-enter-criteria-filters.md
Felsökning: Post låst av en annan användare	ui-troubleshoot-record-locked-another-user.md
Ändra grundläggande inställningar	ui-change-basic-settings.md
Försäljning	sales-manage-sales.md
Ställ in valutor	finance-setup-currencies.md

Ämnesrubriker

Använd imperativt verbformulär för stegbaserade ämnen (Betala leverantörer).
Använd gerund verbform för konceptuella, icke-stegavsnitt (Betalande leverantörer).
Använd substantiv för ämnen på högsta nivå (Försäljning.

Ikoner

Använd följande ikoner med knappbeskrivningar i bildegenskaper som anges i demomediemappen:

Visa fler alternativ
Berätta för mig
Ny post
Växla expandera / komprimera alla
Expandera rad
Komprimera rad
Välj bild
Sök

[! NOT] I vissa listvyer finns en **sökikon ** som inte ska förväxlas med Berätta.

Skärmdumpar - Mindre är mer

Om du vill förklara processer eller begrepp bör du inkludera vissa diagram och andra visuella objekt. Om du inte hittar orden för att tydligt förklara vad du vill att läsaren ska göra kan en skärmdump också hjälpa. I allmänhet behöver du inte inkludera skärmdumpar för gränssnittselement eftersom

De måste ändras varje gång ditt användargränssnitt ändras, annars blir de in förfallna och dina läsare blir förvirrade.
Om användargränssnittet du skriver om är skalbart eller på annat sätt konfigurerbart kan den person som gör skärmbilderna ha en annan layout än standardvärdet, vilket återigen förvirrar läsaren.
skärmbilder kan inte översättas. Om din dokumentation översätts till flera språk måste dina översättare återge skärmdumparna på målspråket.
skärmbilder är dåliga för tillgängligheten. Synskadade användare förlitar sig på text-till-tal för att läsa din dokumentation. Skärmdumpar bidrar inte till skärmläsare, så du måste skriva bra text ändå. Det är därför vi rekommenderar att du använder skärmdumpar sparsamt och endast när det behövs för tydlighet.

Processorienterad kontra uppgiftsorienterad

Försök att skriva processorienterade instruktioner som hjälper användarna att förstå begrepp och processer i stället för att beskriva varje enskild objektsida.

Om steg är viktiga kan skrivandet naturligtvis också vara uppgiftsorienterat.

Metadata

Varje nedmarkeringsfil kan definiera metadata ovanför det första huvudet. De kan definiera alternativ rubrik för sidan eller visa sidbeskrivning i sökresultatet. För vissa program som Dynamics 365 Finance & Operationsmåste de användas för att lägga till information som språk ochinnehållsområde.

Ett enkelt exempel på titel- och beskrivningsimplementering:

---
    title: Alternative Title for Browser and Search
    description: Global search result description (not for local search). 
---