CYTOWANIEKontaktDokumentacja produktu jako źródło: zastosowanie praktyczne
Najważniejsza zasada: Dokumentacja powinna przypisywać funkcję do właściwego produktu oraz wersji. Aktualna strona nie może bez ostrzeżenia zastępować znaczenia wcześniejszej edycji.
Jak zastosować tę zasadę?
Dokumentację oznacz produktem, funkcją, wersją, środowiskiem i datą obowiązywania. Przykłady kodu połącz z opisem rezultatu i ograniczeń.
Przykład
Opis parametru API wskazuje wersję v4, typ wartości, domyślne zachowanie, błąd po przekroczeniu limitu i działający przykład.
Test jakości
Wykonaj przykład w deklarowanym środowisku i sprawdź, czy dokumentowana funkcja działa zgodnie z opisem.
Ograniczenie
Dokumentacja opisuje działanie zamierzone. Awaria produkcyjna może wymagać logów, statusu usługi lub testu.
Minimalna karta źródła
| Warstwa | Pytanie kontrolne | Rezultat |
|---|---|---|
| Potrzeba | Na jakie pytanie odpowiada dokument? | jedna intencja główna |
| Zakres | Dla kogo i kiedy odpowiedź jest prawdziwa? | podmiot, okres, warunki |
| Dowód | Skąd pochodzi twierdzenie? | dane, metoda lub źródło |
| Fragment | Czy zachowuje sens poza stroną? | samodzielna jednostka informacji |
| Identyfikacja | Kto odpowiada za publikację? | autor, wydawca i wersja |
| Dostęp | Czy system może pobrać właściwy wariant? | 200, HTML i canonical |
Co sprawdzić przed publikacją?
Dokumentacja opisuje działanie zamierzone. Awaria produkcyjna może wymagać logów, statusu usługi lub testu.