Konwencje "Pomocy" Serwisu

Ten artykuł opisuje konwencje "Pomocy" Serwisu 4programmers.net.

***

"Pomoc" w Serwisie 4programmers.net (dalej w skrócie "Serwis") posiada następujące konwencje:

  • wyróżnianie pojęć.

Wyróżnianie pojęć

W "Pomocy" Serwisu wyróżniane są pojęcia, które jednocześnie:

  1. posiadają znaczenie specyficzne dla Serwisu (np. "obserwowanie" czy "tagi");
  2. dają się wystarczająco czytelnie zdefiniować.

Stosowane są następujące konwencje:

  • jeśli dane pojęcie pojawia się pierwszy raz w danym artykule "Pomocy" Serwisu oraz w tzw. kontekście własnej definicji, jest formatowane pogrubieniem;
  • jeśli dane pojęcie pojawia się pierwszy raz, ale nie w kontekście własnej definicji, jest za nim umieszczany tekst "patrz niżej" w nawiasie zwykłym;
  • jeśli dane pojęcie pojawia się w innym artykule "Pomocy" Serwisu, niż zostało zdefiniowane, jest formatowane jako link do tego artykułu "Pomocy", który zawiera jego definicję.

"Kontekst własnej definicji" danego pojęcia oznacza taki kontekst (zdanie, akapit, sekcję), który uprawnia czytelnika do założenia, że zawiera definicję tego pojęcia.

0 komentarzy