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.

4
Czy podejmowane są wysiłki w celu zbudowania wspólnie edytowanego odwołania HTML / JS / DOM?
W3Schools ma reputację niekompletnej, czasem niepoprawnej i napędzanej reklamą; mimo to, szukając pewnych rzeczy lub linku do dokumentacji, odpowiadając na pytanie SO, wciąż jest to jedyny przydatny zasób dla różnych przeglądarek. Istnieją inne zasoby, takie jak Mozilla Developer Network, która wykonuje coraz lepszą robotę dokumentując JavaScript oraz legendarny i świetny …
2
Dokumentowanie języka programowania: Instrukcja obsługi
Patrzymy na dokumentację dotyczącą modernizacji w całej naszej linii produktów. Część z nich obejmuje podręczniki do języka programowania używanego jako część systemu. Kiedy pisząc instrukcję obsługi dla języka programowania, jaki jest najlepszy sposób, aby go ustrukturyzować, aby zapewnić maksymalną użyteczność osobom początkującym w języku? Jakie są kluczowe aspekty każdego udokumentowanego …
6
Jak dokumentować reguły biznesowe
Zastanawiam się, jaka byłaby formalna i najczęściej stosowana metoda dokumentowania reguł biznesowych? Również w jaki sposób dokumentujesz specyfikacje interfejsu użytkownika artefaktów programistycznych (np. Dokumentowanie pól formularza i zachowanie przycisków w formularzu, tekście informacyjnym itp.)
6
Czy utworzenie dokumentu projektu oprogramowania po opracowaniu może być uzasadnione?
Obecnie pracuję nad ukończeniem studiów na kierunku „Tworzenie oprogramowania”, w których muszę indywidualnie opracowywać złożone oprogramowanie w firmie zewnętrznej. Wszystko to należy wykonać w sposób ustrukturyzowany, tworząc wszystkie odpowiednie dokumenty. W tym projekcie postanowiłem pracować ze standardowymi dokumentami IEEE: dokument wymagań oprogramowania (SRS), dokumenty architektury oprogramowania (SAD) i dokument projektu …
1
Czy są jakieś badania empiryczne na temat wpływu komentowania kodu źródłowego na jakość oprogramowania, łatwość konserwacji i produktywność programistów? [Zamknięte]
Zamknięte. To pytanie jest nie na temat . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby było tematem dotyczącym wymiany stosów inżynierii oprogramowania. Zamknięte 6 lat temu . Jestem zwolennikiem komentowania kodu źródłowego i dokumentowania oprogramowania. Z mojego osobistego doświadczenia i obserwacji wynika, że ​​praca nad kodem …
1
Czy możliwe jest tworzenie iteracyjnej dokumentacji i czy zapewnia ona skuteczną dokumentację?
Mam projekt na uniwersytet, o którym nie zacznę od razu, ale zastanawiam się nad nim dość długo. Rozumiem, że rozwój projektu uniwersyteckiego nie jest jak przemysł (obecnie sam jestem stażystą), więc sytuacja, którą w tej chwili wskażę, będzie prawdopodobnie wydawać się absurdalna dla prawdziwych programistów. ^^ ” Sam projekt wymaga …
4
Jak dokumentować i uczyć innych „zoptymalizowanych nie do poznania” intensywnych obliczeniowo kodów?
Czasami jest 1% kodu, który jest wystarczająco intensywny obliczeniowo, co wymaga najcięższego rodzaju optymalizacji niskiego poziomu. Przykładami są przetwarzanie wideo, przetwarzanie obrazu i ogólnie wszelkiego rodzaju przetwarzanie sygnału. Celem jest udokumentowanie i nauczenie technik optymalizacji, aby kod nie stał się nieusuwalny i podatny na usuwanie przez nowych programistów. (*) (*) …
5
Jakie elementy dostarcza klientowi aplikacja sieciowa? [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 . Ukończyłem aplikację internetową, która jest zasadniczo opracowana w PHP i jest po prostu kolejną zwykłą …
4
W jaki sposób projekty typu open source mogą odnieść sukces bez dokumentacji dotyczącej ich projektu lub architektury?
Chcę poprawić swoje umiejętności programistyczne, studiując znane projekty open source, ale łatwo się zgubić, po prostu wskakując do ich kodu źródłowego. Postanowiłem więc przeczytać ich dokumentację dotyczącą ich projektu lub architektury (np. Diagramów UML), aby najpierw uzyskać ogólne wyobrażenie o organizacji ich kodu. Ku mojemu zaskoczeniu nie mogę jednak znaleźć …
3
Pisanie propozycji oprogramowania wysokiej jakości [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 5 lat temu . Ostatnio czytałem kilka propozycji projektów oprogramowania i trochę martwię się tym, co widziałem. Często uważam, …
9
Dokumentacja kodu Najpierw? [Zamknięte]
Zamknięte . To pytanie jest oparte na opiniach . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby można było na nie odpowiedzieć faktami i cytatami, edytując ten post . Zamknięte 2 lata temu . Czy ktoś kiedykolwiek próbował najpierw utworzyć pełną dokumentację kodu, a dopiero potem napisał …
9
Badania zysków / strat wydajności dokumentacji
Po wielu poszukiwaniach nie udało mi się odpowiedzieć na podstawowe pytanie dotyczące założonego znanego w świecie twórców oprogramowania: CO JEST ZNANE: Egzekwowanie ścisłej polityki dotyczącej odpowiedniej dokumentacji kodu (czy to znaczników Doxygen, Javadoc, czy po prostu mnóstwa komentarzy) wydłuża czas potrzebny na opracowanie kodu. ALE: Posiadanie dokładnej dokumentacji (lub nawet …
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.