Bekendtgørelser (forklaringer, noter, advarsler osv.),Bemærkninger (forklaringer, noter, advarsler osv.)

DevSite understøtter flere opslagsstile, præsenteret som kasser med forskellige baggrundsfarver. Baggrundsfarverne er foruddefinerede, og du kan oprette meddelelser ved hjælp af enten HTML eller Markdown.

Tilgængelige meddelelsestyper

Note

<aside class="note">
<b>Note:</b> An ordinary note.
</aside>

Note: An ordinary note.

Tip

<aside class="tip">
<b>Tip:</b> An ordinary tip.
</aside>

Tip: An ordinary tip.

Forsigtighed

<aside class="caution">
<b>Caution:</b> Suggests proceeding with caution.
</aside>

Caution: Suggests proceeding with caution.

Advarsel

<aside class="warning">
<b>Warning:</b> Stronger than caution; it means "Don't do this."
</aside>

Warning: Stronger than caution; it means "Don't do this."

Vigtig

<aside class="special">
<b>Important:</b> Defines an important concept.
</aside>

Important: Defines an important concept.

Nøglepunkt

<aside class="key-point">
<b>Key Point:</b> Defines an important takeaway.
</aside>

Key Point: Defines an important takeaway.

Nøgleterm

<aside class="key-term">
<b>Key Term:</b> Defines important terminology.
</aside>

Key Term: Defines important terminology.

Objektiv

<aside class="objective">
<b>Objective:</b> Defines the goal of a procedure.
</aside>

Objective: Defines the goal of a procedure.

Succes

<aside class="success">
<b>Success:</b> Describes a successful action or an error-free status.
Used only in interactive or dynamic content; don't use in ordinary
static pages.
</aside>

Success: Describes a successful action or an error-free status. Used only
in interactive or dynamic content; don't use in ordinary static pages.

Beta

<aside class="beta">
<b>Beta:</b> A notice that describes a beta-release feature, which is
subject to change or removal in new minor versions of the product.
</aside>

Beta: A notice that describes a beta-release feature, which is subject to
change or removal in new minor versions of the product.

Forhåndsvisning

<aside class="preview">
<b>Preview:</b> A note or tip for a feature preview.
</aside>

Preview: A note or tip for a feature preview.

Dogfood

<aside class="dogfood">
<b>Dogfood:</b> A notice that applies only temporarily, during internal
dogfood testing. Remove all Dogfood notices before making a document
publicly visible.
</aside>

Dogfood: A notice that applies only temporarily, during internal dogfood
testing. Remove all Dogfood notices before making a document publicly
visible.

Forældet

<aside class="deprecated">
<b>Deprecated:</b> A note or tip for a deprecated feature, product, or
service.
</aside>

Deprecated: A note or tip for a deprecated feature, product, or service.

Brugsnoter

HTML brug

Vi anbefaler at bruge disse klasser med HTML5 <aside> -elementet, men du kan bruge et andet element på blokniveau (såsom <p> ) i stedet for.

HTML-klasserne bestemmer farven og ikonet for en meddelelse, men de angiver ikke automatisk det første ord med fed skrift; du skal skrive det ord manuelt, som vist i eksemplerne. Du kan teoretisk bruge et andet ord end det, der svarer til klassen, men vi anbefaler, at du holder dig til de første ord vist ovenfor.

I ældre dokumenter kan du se class="special" eller ikke-standard klassenavne i stedet for class="note" . Disse klassenavne producerer meddelelser, der er visuelt identiske med en note , men vi anbefaler at bruge class="note" i stedet for specielle eller ikke-standard klassenavne.

Markdown brug

Markdown-stilene bestemmer farven og ikonet for en meddelelse, og de angiver automatisk det første ord med fed skrift i meddelelsen. Så for eksempel starter en note i Markdown altid med ordet Note: med fed skrift.

For en meddelelse med mere end ét afsnit, brug HTML <aside> (og <p> ) i stedet.

Du kan muligvis se Vigtigt: i stedet for Note: . Denne Markdown-stil producerer meddelelser, der er visuelt identiske med en Note: -meddelelse.

Bedste praksis

DevSite anbefaler, at du overholder følgende bedste praksis, når du tilføjer meddelelser til din dokumentation:

Anbefales

• Vær kortfattet (prøv at holde meddelelser til en eller to sætninger).
• Begræns meddelelser til én pr. side, hvis det er muligt (eller én pr. sektion, hvis det er nødvendigt).
• Sørg for, at meddelelser kun indeholder vigtigt indhold, som du ønsker at fremhæve; medtag ikke indhold i en meddelelse, som du bare ikke er sikker på, hvad du skal gøre med.
• Brug meddelelser før brugeren har brug for oplysningerne, ikke efter.

Ikke anbefalet

• Medtag ikke kodeeksempler, tabeller eller billeder i meddelelser.
• Undgå at stable opslag oven på hinanden, selvom de er af forskellig type.
• Prøv ikke at indsætte opslag umiddelbart efter overskrifter.
• Brug ikke meddelelser til at specificere forudsætninger før en procedure.

For det meste gælder disse bedste fremgangsmåder for meddelelser om note , caution og warning , men kan gælde for andre typer.

Gode ​​eksempler

Hold det enkelt:

Vær cautions ved potentielt tab af data:

Brug warning for potentiel skade:

Brug passende meddelelsestyper for indhold, såsom key-term eller success :

Dårlige eksempler

Bekendtgørelser bør ikke være alt for ordrettede eller formidle oplysninger, der hører hjemme i kerneindholdet:

Meddelelser bør ikke specificere forudsætninger før en procedure (brug i stedet en "Forudsætninger"-sektion):