Jak pisać dokumentacje?

pytanie zadane 9 lipca 2018 w Offtop przez Layoutowiec Mądrala (5,470 p.)

Witam wszystkich!

W końcu nadszedł czas na moją pierwsza dokumentacje . No ale nigdy żadnej nie pisałem, przez co nie wiem jak się do tego zabrać. Przeczytałem kilka poradników ale chciałbym wiedzieć jak to miałoby wyglądać (co trzeba opisywać, jak itd.) Jakby co to muszę ją napisać do html-a, css-a i JS-a

Dzięki za czas jaki poświęciliście na moje pytanie :)

komentarz 9 lipca 2018 przez hun1er76 Stary wyjadacz (11,960 p.)

Będziesz pisał dokumentację do witryny internetowej? :)

komentarz 9 lipca 2018 przez Layoutowiec Mądrala (5,470 p.)

Do layoutu strony która chce sprzedać na wrapbootstrap a tam dokumentacja jest wymagana

1 odpowiedź

odpowiedź 9 lipca 2018 przez Tomek Sochacki Ekspert (227,510 p.)

Poczytaj sobie różne dokumentacje bibliotek na GH, jest tego masa.

Ale tak generalnie to wg mnie dokumentację warto ograniczać do minimum i po prostu pisać samokomentujący się kod. To tak samo jak z komentarzami... możesz zrobić:

function setUserName(name) {
    // kod ustawiający name
}

a możesz:

// Funkcja ustawiająca imię użytkownika:
function fn(x) {
    // ustawienie imienia zapisanego w "x"
}

Sam sobie odpowiedz na pytanie co lepsze, dobra nazwa funkcji czy usilne ładowanie komentarzy do bezsensownej nazwy :)

komentarz 9 lipca 2018 przez Layoutowiec Mądrala (5,470 p.)

Też uważam że najłatwiej ograniczyć się do samego kodu pisząc komentarze ale tak jak mówiłem koledze wyżej że wymaga tego strona wrapbootstrap dla której jest layout

komentarz 10 lipca 2018 przez Layoutowiec Mądrala (5,470 p.)

Ok i jeszcze mógłbym pisać coś na zasadzie np.

100 linijka: i tutaj opis co robi

A jeżeli nie to jak i jaki w ogóle powinna mieć końcówkę (.txt itd..)