Pytania otagowane jako documentation

Dokumentacja oprogramowania jest tekstem towarzyszącym oprogramowaniu komputerowemu. Wyjaśnia, jak działa oprogramowanie, jak go zainstalować, jak go używać i inne zasoby pomocy.

3
Jak dokumentować niekoniecznie złożone struktury kodu?
Jeśli mam fragment kodu, który jest matematycznie lub strukturalnie dość złożony i nieredukowalnie, to jak miałbym udokumentować ten fragment kodu? W szczególności, w jaki sposób mogę zapewnić, że ktoś, kto może nie mieć umiejętności matematycznych lub architektonicznych, które rozumiem, może to zrozumieć z dokumentacji? Czy powinienem również dokumentować całą matematykę? …
3
Jaki jest związek między programowaniem piśmiennym a siecią semantyczną?
(Przypadkowo) badałem podejścia oparte na semantyce / ontologii do dokumentacji technicznej, kiedy natknąłem się na ten klejnot : Programowanie piśmienne i sieć semantyczna to pomysły z różnych czasów, które mają związek. Dokument połączony, Literate Programming in XML autorstwa Normana Walsha, omawia technologie XML, które są kluczowe dla sieci semantycznej, jednak …
7
Jak mogę udokumentować przeszłe prace innej osoby? [Zamknięte]
Zamknięte . To pytanie musi być bardziej skoncentrowane . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby skupiało się tylko na jednym problemie, edytując ten post . Zamknięte 4 lata temu . Jesteśmy w złej sytuacji, gdy mamy bardzo mało dokumentacji na temat dostosowywania naszych byłych pracowników …
4
Jakie rzeczy umieszczasz w dokumencie analizy wpływu?
Więc naprawiasz błędy, a następnie napotkałeś taki, który mógłby wpłynąć na inne moduły oprogramowania. Twoje dane nie są wystarczające, aby uzasadnić swoje twierdzenie o skutkach poprawki i poproszono Cię o utworzenie dokumentu analizy wpływu. Czy istnieje zdefiniowany proces, w jaki sposób to zrobić? Jakie potrzebne są kluczowe informacje? Czy są …
3
za pomocą wiki dla wymagań
Szukam sposobów usprawnienia zarządzania wymaganiami. Obecnie mamy dokument Word opublikowany na stronie internetowej. Niestety nie możemy (o ile wiem) patrzeć na zmiany z jednej wersji do drugiej. Wolałbym móc to zrobić, podobnie jak w przypadku wiki lub VCS (lub obu, takich jak wiki na bitbucket!). Ponadto w każdym dokumencie opisano …
7
Style komentowania / dokumentacji w kodzie
To może być głupie pytanie, ale przez jakiś czas było w mojej głowie i nigdzie indziej nie mogę znaleźć porządnej odpowiedzi. Mam nauczyciela, który mówi, że powinniśmy wyraźnie wymienić każdy parametr z opisem, nawet jeśli jest tylko jeden. Prowadzi to do wielu powtórzeń: double MyFunction(const int MyParam); // Function: MyFunction …
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.