Pytania oznaczone «documentation»

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...

Obecnie używam dwóch systemów do pisania dokumentacji kodu (używam C ++): Dokumentacja o metodach i członkach klasy jest dodawana obok kodu, w formacie Doxygen. Na serwerze Doxygen jest uruchamiany na źródłach, dzięki czemu dane wyjściowe można zobaczyć w przeglądarce internetowej Strony...

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...

Mam bazę danych MongoDB, którą chcę poprawnie udokumentować jej projekt schematu. Wiem, że MongoDB jest bazą danych NoSQL i z natury nie ma schematów, ale egzekwuję schemat w mojej aplikacji i chcę go przedstawić w lepszy sposób niż wydruk findOne()wyniku. Widzę wiele osób używających ER lub UML,...

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 . W przypadku projektu...

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...

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...

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ć...

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ą...

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ą...

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...

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...

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ć...

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ż...

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...

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

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...

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 4 lata temu . Za każdym razem, gdy...

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 . Nasza firma ma zamiar...

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)...