COSMO-specifika format

Innehållet på webbplatsen följer https://docs.cosmoconsult.comi allmänhet den här stilguiden. Innehållet för de olika manualerna varierar på vissa sätt, delvis med produktspecifik terminologi.

[! NOT] Våra dokumentationsprojekt är skrivna på engelska (amerikansk stavning). Mer information finns i Namngivningen av filer.

Allmänt

  • Vi behöver inte inkludera varumärken som Microsoft Dynamics 365 Business Central®. Skriv bara: Microsoft Dynamics 365 Business Central.

  • Förkorta inte något av Microsoft Dynamics 365-namnen eller förvandla dem till akronymer. Skriv till exempel Microsoft Dynamics 365 Business Central. Du kan utelämna Microsoft om ordet Microsoft redan har använts i text tidigare i kommunikationen, till exempel i en tidigare referens till ett produktnamn.

  • Definiera akronymer - Definiera detta i ord i innehållet, följt av förkortningen inom parentes innan du använder den, till exempel: Den erbjuder ett brett utbud av PDM-funktioner (Product Data Management).

  • Utropstecken (!) ska inte användas.

  • Använd inte tvetydiga ord, till exempel askontra because. Becauseär tydligare för översättning.

  • Använd inte om pleasedu inte beskriver en situation som besvärar användaren på ett ovanligt sätt eller ber användaren att vänta.

  • Du mot användaren

    • Ändra *användare / användare / han / hon * etc. till dig *om * möjligt, eller skriv om meningar för att utesluta användaren eller dig.

  • Kryssrutor som nu är växlar

    • Använd följande beskrivningar:
      • Slå på (eller inaktivera) xxx-växlingsknappen.
      • Om xx-växlingsknappen är på på xx-sidan och så vidare.
      • Om xx-växlingsknappen är avstängd på xx-sidan och så vidare.

[! NOT] Glöm inte att komma ihåg de grundläggande principerna i **COSMO:s ** kommunikationsriktlinje.
Mer information om Microsofts skrivstil och terminologi finns i Guiden Skrivstil i Microsoft.

Formatering

Använd **fetstil ** för att framhäva produktnamn (till exempel COSMO Data Integration **Framework)**och gränssnittselement som fält, åtgärder och objekt.

Lägg till ordet *åtgärd * runt åtgärder.

Så istället för: skriva:
Välj **Bokför ** om du vill bokföra ordern. Välj åtgärden **Bokför ** för att bokföra ordern.

Använd kursiv för att framhäva värden.

Standardfraser

Alla fält och åtgärder i Business Central kan ha knappbeskrivningar. Dokumentera därför inte fält i hjälpen, utan försök att använda verktygstipsen för att svara på de flesta omedelbara frågor om vad fält och åtgärder gör.

Om du vill hänvisa läsarna till knappbeskrivningarna använder du den här standardfrasen där det är relevant:

Välj ett fält om du vill läsa en kort beskrivning av fältet eller länka till mer information.

Mer information om hur du skriver verktygstips finns i Riktlinjer för verktygstipstext.

Skriva tips

Mer information om hur du gör innehåll som är lätt att läsa finns i Tips om Microsoft-skrivning.