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.

8
W przyszłości przejście od projektu jednoosobowego do projektu zespołowego. Co powinienem teraz robić w ramach przygotowań i na co mogę czekać?
Aby to wyjaśnić, jestem zainteresowany wiedzą, co ludzie myślą, że powinieneś wdrożyć, będąc jeszcze jednoosobowym projektem (kontrola źródła zespołu, dokumentacja, kompilacje itp.) I jakich rzeczy nie trzeba robić, dopóki nie pojawi się druga osoba na projekt. Każdy, kto ma doświadczenie w poruszaniu się w tym scenariuszu, doceni ich spostrzeżenia.
7
Czy dokument projektowy powinien zawierać omówienie zalet / wad danego projektu, czy powinien koncentrować się na faktach i uzasadnieniu?
Obecnie jestem w trakcie aktualizacji dokumentu projektowego, aby był poprawny i aktualny dla przyszłych programistów. Obecnie dokument koncentruje się tylko na faktach, przedstawiając projekt. Nie ma uzasadnienia dla jakichkolwiek przedstawionych decyzji. Uważam, że ważne jest uchwycenie uzasadnienia, aby programiści wiedzieli, dlaczego coś takiego jest, ponieważ prawdopodobnie wpłynie to na przyszłe …
5
Jak udokumentować projekt, który jest już opracowany?
Chciałbym wiedzieć, jakie opcje są dostępne do dokumentowania projektu, który został już opracowany, ponieważ programiści, nad którymi pracowali, nie napisali ani jednej strony dokumentacji. Projekt nie zawiera żadnych innych szczegółów poza wieloma stronami skryptów z funkcjami napisanymi i zmodyfikowanymi przez programistów, którzy pracowali nad tym projektem przez ostatnie 2 lata. …
3
Jak czytać RFC i podobne dokumenty? [Zamknięte]
Zamknięte . To pytanie wymaga szczegółów lub jasności . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Dodaj szczegóły i wyjaśnij problem, edytując ten post . Zamknięte 4 lata temu . RFC : Zapytanie o komentarze (RFC) to memorandum opublikowane przez Internet Engineering Task Force (IETF) opisujące metody, zachowania, badania …
5
Menedżer oprogramowania, który zmusza programistów do zarządzania projektami
Jestem programistą pracującym w firmie zajmującej się systemami wbudowanymi. Mamy Project Managera, który zajmuje się ogólnym harmonogramem projektu (w tym elektrycznym, jakościowym, oprogramowania i produkcji), dlatego jego harmonogram oprogramowania jest bardzo krótki. Mamy także Menedżera oprogramowania, który jest moim szefem. Zmusza mnie do pisania i utrzymywania harmonogramu oprogramowania, dokumentów projektowych …
3
Jak udokumentować eksperymentalne lub niekompletne interfejsy API, takie jak @deprecated?
Czy istnieje dobry termin, który jest podobny, ale różni się od „przestarzałe”, co oznacza, że ​​metoda lub interfejs API znajduje się w bazie kodu, ale nie należy go stosować, ponieważ jego implementacja nie jest kompletna lub prawdopodobnie ulegnie zmianie? (Tak, wiem, te metody nie powinny być publiczne, yada yada yada. …
7
Dokumentacja poniżająca - jak sobie z tym poradzić?
Ważne : nie mamy żadnych problemów z dokumentacją kodu źródłowego . Należy to do regularnego audytu kodu i jest na bieżąco aktualizowane. Nasz problem dotyczy dokumentacji programistów (lub „zewnętrznych”, jeśli chcesz), małych blogowych wskazówek od programistów do programistów, które zwykle są pisane, często pozostawione. Używamy systemu typu wiki do tworzenia …
4
Co dokładnie obejmuje „dokumentację”?
Kiedy mówimy „dokumentacja” dla oprogramowania, co to obejmuje, a czego nie powinno to obejmować? Na przykład ostatnie pytanie, czy komentarze są uważane za dokumentację? Ale jest wiele innych dziedzin, dla których jest to również ważne pytanie, niektóre bardziej oczywiste niż inne: Instrukcje (oczywiście) Informacje o wydaniu? Poradniki Komentarze Ktoś jeszcze? …
5
Co to jest „domena problemowa”
Muszę udokumentować swój program dla projektu szkolnego i mamy sekcję o nazwie „domena problemowa”, ale nie mam pojęcia o czym dyskutować w tej sekcji. Pytanie brzmi zatem: co należy omówić w dziedzinie problemów?
5
Alternatywny do pomocy HTML
Obecnie używamy systemu o nazwie AsciiDoc, który pozwala nam tworzyć dokumentację za pomocą prostego znacznika tekstowego. Z tego możemy wygenerować wiele formatów wyjściowych. Używamy tylko formatów wyjściowych pdf i chm. Zastanawiałem się, czy istnieje alternatywa dla chm? To, czego szukam, to coś, czego można używać w trybie offline (jest to …
4
Jak zarządzać dokumentacją projektu typu open source? [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 6 lat temu . Jestem twórcą rozwijającego się projektu open source. Obecnie zaczynam się denerwować, próbując znaleźć najlepszy sposób …
5
Po co zawracać sobie głowę rozróżnianiem wymagań funkcjonalnych od niefunkcjonalnych?
Rozumiem różnicę między nimi, ale koledzy pytają mnie o korzyści płynące z wymagań dotyczących etykietowania jako funkcjonalnych lub niefunkcjonalnych (lub przejściowych). Po co to robić? Spędził dwa dni, przeglądając listę wymagań dla jednego projektu, i nie widział w tym żadnej korzyści, ponieważ końcowym rezultatem było przekazanie dokumentu innemu podmiotowi gospodarczemu …
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.