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.

2
Wszechobecny język - konflikt między poprawnością a użytecznością
Zasadniczą częścią Domain Driven Design jest konsekwentne stosowanie wszechobecnego języka w całym systemie - w rozmowach, kodzie, schemacie bazy danych, interfejsie użytkownika, testach itp. Jestem zaangażowany w projekt, w którym istnieje już dobrze ugruntowany język domen, zdefiniowany przez międzynarodową organizację normalizacyjną. Jednak praca, którą wykonujemy, dotyczy publicznej witryny internetowej, a …
5
Dokumentacja kodu: publiczny czy niepubliczny?
Jestem jednym z tych programistów, którzy myślą, że napisany kod powinien być zrozumiały i czytać jak książkę. JEDNAK, opracowując kod biblioteki dla innych osób, staram się umieszczać jak najwięcej dokumentacji w plikach nagłówków; co rodzi pytanie: czy warto udokumentować metody niepubliczne? Nie będą ich używać bezpośrednio, w rzeczywistości nie mogą. …
5
Dobre referencje do przykładów dokumentacji dla użytkowników końcowych i porady [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 . Nasze oprogramowanie było używane przez wielu użytkowników, a dział szkoleń poprosił nas o wszelkie wskazówki dotyczące formatu dokumentacji użytkownika …
1
Jak prawidłowo udokumentować algorytm przykładowymi danymi?
Zastanawiam się, co powinna zawierać dokumentacja algorytmu? Nie można znaleźć właściwej wytycznej do naśladowania. Mam na myśli to podsumowanie algorytmu opis algorytmu schematy blokowe pseudo kody przykładowy zestaw danych wejściowych (wiele) dane wyjściowe testy jednostkowe eksperymenty Klient prosi o taką dokumentację, aby: Utrzymać zaufanie do własnych numerów, a także opisać …
5
Jaki jest najlepszy sposób przechowywania dokumentacji związanej z projektem kodu?
Mamy wiele dokumentów związanych z tworzeniem naszego oprogramowania. Należą do nich między innymi wymagania, dokumenty projektowe, zewnętrzne pliki PDF, pliki klientów, instrukcje testowania itp. Obecnie dokumenty te są rozrzucone po całym miejscu (wiki, „jakieś miejsce w sieci”, dysk twardy lokalnego programisty (!), i jeszcze gorsze miejsca). Jaki jest najlepszy sposób, …
1
Implikowana precyzja funkcji zmiennoprzecinkowych
Przeglądając implementację funkcji innego programisty w celu obliczenia CDF o rozkładzie normalnym , zasugerowałem, aby albo zastąpić całą implementację wbudowanymi funkcjami Pythona, albo użyć SciPy, wspólnej biblioteki naukowej. Inny programista zauważył, że ani math.erfc()nie scipy.stats.norm.cdf()zapewnia żadnych gwarancji dokładności w swojej dokumentacji. Dlatego powinienem być bardziej ostrożny przy zastępowaniu algorytmu aproksymacyjnego …
1
Jak aktualizować przykłady kodu w javadocs
Pracuję nad małą biblioteką, która zapewnia implementacje podstawowych, dobrze znanych metryk ciągu. Głównie dla mojej własnej edukacji. Rozwój odbywa się za każdym razem, gdy mam trochę wolnego czasu. Z tego powodu zautomatyzowałem większość procesów, dzięki czemu mogę wypuszczać wersję tak często, jak pracuję nad nią bez większego wysiłku. Jednak utrzymanie …
4
Czy powinniśmy szukać kłamliwego kodu?
Odnosi się to do dyskusji w odpowiedzi i komentarzy do tego pytania: Co jest związane z awersją do dokumentacji w branży? . W odpowiedzi twierdzono, że „kod nie może kłamać”, a zatem powinna być lokalizacją docelową zamiast dokumentacji. Kilka komentarzy wskazuje, że „kod może kłamać”. Po obu stronach jest prawda, …
3
Jak odwoływać się do określonych obszarów kodu w dokumentacji?
Mam zamiar opuścić projekt i zanim odejdę, mój szef poprosił mnie o udokumentowanie kodu (nie udokumentowałem zbyt dobrze). To nie jest wielka sprawa, projekt nie jest strasznie skomplikowany. Ale w mojej dokumentacji znajduję miejsca, w których chciałbym powiedzieć: „Zawiadomienie w linii XYZ, że takie i takie się zdarzają”. W takim …
3
Jak śledzić złożone reguły biznesowe poza kodem?
Chcę zobaczyć, jak robią to inni ludzie. Zwłaszcza w sytuacjach, gdy wielu różnych klientów korzysta z tej samej bazy oprogramowania z nieco innymi regułami biznesowymi. Jakich praktyk używasz do dokumentowania, jak wszystko ma działać, czy reguł biznesowych. Zasadniczo więc, gdy nowy programista pojawia się w zespole, jest łatwy dostęp do …
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.