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.

1
jaki system dokumentacji technicznej online poleciłbyś? [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 6 lat temu . celem jest posiadanie systemu dokumentacji online z tymi głównymi wymaganiami: będą wykorzystywane głównie …
5
Czy opis architektury stanowi naruszenie zasady DRY?
Zasada DRY (Don't Repeat Yourself) mówi, że „każda wiedza musi mieć jedną, jednoznaczną, autorytatywną reprezentację w systemie”. Najczęściej odnosi się to do kodu, ale często obejmuje również dokumentację. Mówi się, że każdy system oprogramowania ma architekturę, niezależnie od tego, czy ją wybierzesz, czy nie. Innymi słowy, oprogramowanie, które budujesz, ma …
5
Szablony / wymagania dotyczące propozycji projektu [zamknięte]
W obecnej formie to pytanie nie pasuje do naszego formatu pytań i odpowiedzi. Oczekujemy, że odpowiedzi poparte będą faktami, referencjami lub wiedzą fachową, ale to pytanie prawdopodobnie będzie wymagało debaty, argumentów, ankiet lub rozszerzonej dyskusji. Jeśli uważasz, że to pytanie można poprawić i ewentualnie ponownie otworzyć, odwiedź centrum pomocy w …
4
Najlepsza praktyka oznaczania metody, która jest wywoływana przez odbicie?
Nasze oprogramowanie ma kilka klas, które należy dynamicznie znaleźć poprzez odbicie. Wszystkie klasy mają konstruktor z określoną sygnaturą, za pośrednictwem której kod odbicia tworzy instancję obiektów. Jednak gdy ktoś sprawdzi, czy metoda jest przywołana (na przykład za pomocą soczewki Visual Studio Code Lens), referencja za pomocą odbicia nie jest liczona. …
6
Czy komentarze są uważane za formę dokumentacji?
Kiedy piszę dla siebie małe skrypty, układam swój kod wysoko w stos z komentarzami (czasami komentuję więcej niż koduję). Wiele osób, z którymi rozmawiam, mówi, że powinienem dokumentować te skrypty, nawet jeśli są one osobiste, więc jeśli kiedykolwiek je sprzedam, będę gotowy. Ale czy komentarze nie są formą dokumentacji? Czy …
4
Zamieść link do odpowiedniej dokumentacji w komunikacie o błędzie?
Tworzymy komercyjną bibliotekę i przykłady kodu, które są używane przez zewnętrznych programistów. Mamy (zamkniętą, dostępną dla zarejestrowanych użytkowników) dokumentację, która szczegółowo wyjaśnia, jak korzystać z biblioteki. Wielu programistów jest użytkownikami po raz pierwszy, więc napotyka się na wiele podstawowych błędów. Czy właściwe jest umieszczenie łączy do dokumentacji w dzienniku błędów? …
5
Używanie różnych wzorów dla podobnych funkcji
Jestem jedynym programistą w projekcie, który, jak w przypadku każdego projektu oprogramowania, może być zajęty przez kogoś innego w przyszłości. Powiedzmy, że użyłem wzorca X do implementacji funkcji A. Po opracowaniu i ukończeniu tej funkcji, zdaję sobie sprawę, że mogę zaimplementować tę samą funkcję przy użyciu wzorca Y, o której …
1
Jakie informacje powinny znajdować się w github README.md?
Jakich informacji spodziewałbyś się zobaczyć w github README? Czy wszystko powinno iść w CZYTELNIKU? to znaczy Wprowadzenie Instalacja Wersje Podręcznik użytkownika Realizacja Testowanie Powiązane zasoby A może powinieneś po prostu umieścić pewne rzeczy w README (wprowadzenie, instalacja, wersje), a inne informacje najlepiej umieścić na wiki Github?
3
Czy komentarze XML są niezbędną dokumentacją?
Kiedyś byłem fanem wymagania komentarzy XML do dokumentacji. Od tego czasu zmieniłem zdanie z dwóch głównych powodów: Podobnie jak dobry kod, metody powinny być zrozumiałe. W praktyce większość komentarzy XML to bezużyteczny szum, który nie zapewnia żadnej dodatkowej wartości. Wiele razy po prostu używamy GhostDoc do generowania ogólnych komentarzy, a …
5
Czy dobrym pomysłem jest pisanie specyfikacji wymagań według historii?
Obecnie używamy zwinnych metod w moim obecnym projekcie i mamy mnóstwo takich historii: Jako asystent chcę zwrócić klientowi zwrot pieniędzy, aby mógł otrzymać pieniądze na żądanie Jako klient chcę zapłacić za zakup, aby otrzymać przedmiot. Jak dotychczas to zrobiliśmy, wybieramy najważniejsze historie podczas każdego sprintu i opracowujemy je w szeregu …
5
Określenie odpowiedniej ilości dokumentacji
Tam, gdzie obecnie pracuję, ogólne podejście to: unikaj dokumentacji w jak największym stopniu Dokumentuj tylko, jeśli inny zespół będzie go potrzebował tylko dla wyjaśnienia, nie chodzi mi o dokumentację kodu - chodzi o całą dokumentację związaną z procesem projektowania - jeśli są to schematy UML lub DB, diagramy klas i …
5
Lepszy sposób na szkolenie nowych pracowników [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 . Zespół, w którym obecnie uczestniczę, ma dość duże obroty, a członkowie zwykle przenoszą się do …
5
Czy komentarz do metody powinien zawierać zarówno podsumowanie, jak i zwrócony opis, gdy często są tak podobne?
Jestem zwolenniczką odpowiednio udokumentowanego kodu i doskonale zdaję sobie sprawę z jego wad . To nie wchodzi w zakres tego pytania. Lubię przestrzegać zasady dodawania komentarzy XML dla każdego członka publicznego, biorąc pod uwagę, jak bardzo lubię IntelliSense w Visual Studio. Jest jednak jedna forma redundancji, która przeszkadza nawet tak …
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.