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.

5
Jak przejść do pisania specyfikacji języka programowania?
Naprawdę lubię projektowanie języka programowania. Czasami myślę, że moje projekty językowe i ich potencjalni użytkownicy skorzystaliby z kompleksowego dokumentu normalizacyjnego. Przyjrzałem się wielu standardom językowym, od bardzo formalnego (C ++) do raczej nieformalnego (ECMAScript), ale tak naprawdę nie mogę zrozumieć, w jaki sposób powinienem rozwiązać problemy i zorganizować taki dokument, …
6
Czy możesz twierdzić, że Twój produkt jest odpowiedni, jeśli korzysta z oprogramowania OSS, które go nie gwarantuje?
Pracuję nad produktem dla klienta, który musi być ważny i odpowiedni do określonego celu. Jest zbudowany na stosie LAMP (PHP / Cake), więc istnieją licencje GPL, MIT, PHP, APACHE: PODSTAWA W STANIE, W JAKIM JEST, BEZ JAKICHKOLWIEK GWARANCJI LUB WARUNKÓW, wyraźnych lub dorozumianych, w tym, bez ograniczeń, jakichkolwiek gwarancji lub …
7
Jak dostosować Scrum do środowiska akademickiego?
Obecnie współpracuję z profesorem na moim uniwersytecie, aby opracować nowe programy nauczania dla kursów inżynierii oprogramowania i projektowania Capstone oferowanych na mojej uczelni. Do niedawna oba kursy korzystały wyłącznie z modelu wodospadu, dlatego uczniowie spędzali większość czasu na pisaniu długich raportów. Po mojej dużej presji mój profesor postanowił włączyć Scrum …
6
Oprogramowanie do organizowania i utrzymywania dokumentacji projektowej, specyfikacji? [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 . Szukam oprogramowania do organizowania i utrzymywania wewnętrznej dokumentacji projektów, specyfikacji, wymagań itp. Obecnie przechowujemy całą dokumentację jako wiele plików …
6
Czy powiedzenie „Obiekt JSON” jest zbędne?
Jeśli JSON oznacza JavaScript Object Notation, to kiedy mówisz obiekt JSON, czy tak naprawdę nie mówisz „JavaScript Object Notation Object”? Czy powiedzenie „ciąg JSON” byłoby bardziej poprawne? A może po prostu powiedz JSON? (jak w „Te dwie usługi przekazują między sobą JSON”).
4
Pisanie specyfikacji wymagań oprogramowania
Mam kilka pytań na temat pisania specyfikacji i są to: Kiedy piszemy specyfikację oprogramowania, w temacie „Definicja wymagań użytkownika” musimy określić tylko „Funkcje” i „Ograniczenia”? Czy „interfejs użytkownika” mieści się w „funkcjach” lub „ograniczeniach”? Jakie są główne kluczowe obszary (wymagania), na które można podzielić oprogramowanie (np. Interfejs użytkownika)?
8
Ile dokumentacji wystarczy?
Ile dokumentacji technicznej (dla przyszłych programistów) wystarcza ? Czy istnieje odpowiedni stosunek między kodowaniem godzin a dokumentowaniem godzin, który jest odpowiedni? Papadimoulis twierdzi , że powinieneś stworzyć najmniejszą ilość dokumentacji potrzebnej do jak najlepszego zrozumienia, Czy to dobra wskazówka, czy są jakieś konkretne rzeczy, które powinienem stworzyć?
7
Co powinienem zawrzeć w nagłówku dokumentacji zajęć
Szukam pouczającego formatu dokumentacji klas dla moich klas Entity, Business Logic i Data Access. Znalazłem następujące dwa formaty stąd Format 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: /// Name: Date: Description: ///----------------------------------------------------------------- Format …
1
Jak udokumentować język wszechobecny?
Nasza firma jest w trakcie przekształcania wielu ręcznych procesów biznesowych (i powiązanej wiedzy instytucjonalnej) w nowe oprogramowanie dla przedsiębiorstw. Projekt idzie naprawdę dobrze, ale w miarę postępów staje się jasne, że istnieje wiele nieporozumień dotyczących terminów i definicji zarówno po stronie biznesowej, jak i programistycznej. Od jakiegoś czasu zdaję sobie …
2
Jak mam odnotować, że klasa jest niezmienna w Javie?
Ostatnio natknąłem się na to, jak przydatne są niezmienne obiekty i że np. Jeśli przekazujesz elementy do konstruktora, a twoja klasa powinna być niezmienna, musisz skopiować te elementy, jeśli same nie są niezmienne. Wymaga to dużej ilości sprawdzania lub wiedzy na temat mojego projektu, ponieważ jeśli mam public A(B foo) …
6
Dlaczego tak wiele bibliotek nie ma / kiepskiej dokumentacji? [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 . W podobny sposób jak w Jak projekty open source mogą odnieść sukces bez dokumentacji dotyczącej …
4
Pisanie przypadków testowych przyjęcia
Integrujemy proces testowania z naszym procesem SCRUM. Moją nową rolą jest pisanie testów akceptacyjnych naszych aplikacji internetowych, aby zautomatyzować je później. Dużo czytałem o tym, jak należy pisać przypadki testowe, ale żaden nie dał mi praktycznych porad, jak napisać przypadki testowe dla złożonych aplikacji internetowych, a zamiast tego rzucił sprzeczne …
8
Gdzie umieścić dokumentację kodu?
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 przeglądowe (opisujące zestaw klas, strukturę aplikacji, przykładowy kod, ...) …
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.