• Najnowsze pytania
  • Bez odpowiedzi
  • Zadaj pytanie
  • Kategorie
  • Tagi
  • Zdobyte punkty
  • Ekipa ninja
  • IRC
  • FAQ
  • Regulamin
  • Książki warte uwagi

Jak pisać dokumentacje?

VPS Starter Arubacloud
0 głosów
521 wizyt
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 smiley. 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 smiley

 

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ź

+2 głosów
odpowiedź 9 lipca 2018 przez Tomek Sochacki Ekspert (227,490 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 layoutlaugh 

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..)

Podobne pytania

0 głosów
2 odpowiedzi 242 wizyt
pytanie zadane 27 grudnia 2017 w HTML i CSS przez Szycha Gaduła (4,650 p.)
0 głosów
1 odpowiedź 427 wizyt
pytanie zadane 12 lutego 2022 w Java przez dwagrosze Nowicjusz (120 p.)
0 głosów
1 odpowiedź 715 wizyt
pytanie zadane 19 marca 2019 w C# przez Shimeo7 Obywatel (1,910 p.)

93,018 zapytań

141,984 odpowiedzi

321,282 komentarzy

62,364 pasjonatów

Motyw:

Akcja Pajacyk

Pajacyk od wielu lat dożywia dzieci. Pomóż klikając w zielony brzuszek na stronie. Dziękujemy! ♡

Oto polecana książka warta uwagi.
Pełną listę książek znajdziesz tutaj

Wprowadzenie do ITsec, tom 2

Można już zamawiać tom 2 książki "Wprowadzenie do bezpieczeństwa IT" - będzie to około 650 stron wiedzy o ITsec (17 rozdziałów, 14 autorów, kolorowy druk).

Planowana premiera: 30.09.2024, zaś planowana wysyłka nastąpi w drugim tygodniu października 2024.

Warto preorderować, tym bardziej, iż mamy dla Was kod: pasja (użyjcie go w koszyku), dzięki któremu uzyskamy dodatkowe 15% zniżki! Dziękujemy zaprzyjaźnionej ekipie Sekuraka za kod dla naszej Społeczności!

...