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.

20
Czy powinieneś napisać dobrą dokumentację i czysty kod, aby zwiększyć „współczynnik magistrali”?
Jednym z głównych celów firm zajmujących się tworzeniem oprogramowania jest zwiększenie ich współczynnika autobusu. Jest to również zalecane w rozmowie zorganizowanej przez Google . Oznacza to, że powinieneś zakodować i udokumentować wszystko w taki sposób, że jeśli jutro wpadniesz na autobus, projekt może być kontynuowany. Innymi słowy, powinieneś dać się …
14
O co chodzi z niechęcią do dokumentacji w branży?
Wydaje się, że istnieje awersja do pisania nawet najbardziej podstawowej dokumentacji. Nasze projekty README są stosunkowo puste. Dokumenty nie zawierają nawet zaktualizowanych list zależności. Czy jest coś, czego nie znam w branży, co sprawia, że ​​programiści nie lubią pisać dokumentacji? W razie potrzeby mogę pisać akapity dokumentów, więc dlaczego inni …
6
„I”, „My” lub Ani w dokumentacji kodu
Uważam, że piszę (mam nadzieję) pomocne komentarze w dokumentacji typu C ++: The reason we are doing this is... Powodem, dla którego używam słowa „my” zamiast „ja” jest to, że dużo piszę w środowisku akademickim, gdzie „my” jest często preferowane. Oto pytanie. Czy istnieje dobry powód, aby preferować jeden nad …
12
Dokumentacja w OOP powinna unikać określania, czy „osoba pobierająca” wykonuje jakieś obliczenia?
Program CS mojej szkoły unika jakiejkolwiek wzmianki o programowaniu obiektowym, więc czytam sam, aby go uzupełnić - w szczególności Object Oriented Software Construction autorstwa Bertrand Meyer. Meyer wielokrotnie podkreśla, że ​​klasy powinny ukrywać jak najwięcej informacji o ich implementacji, co ma sens. W szczególności wielokrotnie argumentuje, że atrybuty (tj. Statyczne, …
6
Format arkusza kalkulacyjnego przyjazny dla Gita? [Zamknięte]
Staramy się przenieść proces dokumentacji projektu z Dokumentów Google do zestawu hostowanych przez siebie repozytoriów Git. Dokumenty tekstowe są wystarczająco przyjazne dla Gita, ponieważ zwykle nie potrzebujemy żadnego fantazyjnego formatowania, po prostu przekonwertujemy wszystko na, powiedzmy, multimarkdown z opcją osadzenia LaTeXa w skomplikowanych przypadkach. Ale arkusze kalkulacyjne to zupełnie inna …
9
Czy osoby spoza branży IT mogą obsługiwać wiki? [Zamknięte]
Moja firma chce usprawnić zarządzanie danymi z badań rynku. Aktualny styl zarządzania danymi: „Hej, Jimbo, gdzie jest to zdjęcie naszego WhatZit 2.0? „tak, pamiętam ten e-mail o tej firmie od tego faceta, daj mi kilka minut na przeszukanie mojego programu Outlook” „kto ma najnowszą kopię katalogu produktów ważnego konkurenta? Mój …
6
Metodologia dokumentowania istniejącej bazy kodu
Pracuję jako część zespołu nad istniejącą aplikacją, która nie ma wbudowanej dokumentacji ani dokumentacji technicznej. Pracując nad różnymi zgłoszeniami błędów dotyczących aplikacji, napisałem dla siebie coś w rodzaju ścieżki nawigacyjnej - numery błędów w różnych miejscach, aby następny programista mógł skorzystać z tego numeru błędu, aby zobaczyć, co się dzieje. …
3
Jakie przeszkody stoją w obliczu procesu opracowywania przy użyciu zwykłych języków znaczników w przeciwieństwie do np. Microsoft Word? [Zamknięte]
Obecnie jestem stażystą u kontrahenta rządowego i mam (obrzydliwie nieuniknione) wrażenie, że Word jest de facto standardem w procesie tworzenia oprogramowania. Jego format binarny bardzo utrudnia współpracę nad dokumentami w sposób, w jaki jestem przyzwyczajony do współpracy na bazie kodu. Użycie znaczników zwykłego tekstu (w takich językach, jak LaTeX, Markdown, …
2
Jak zrobić dokumentację dla kodu i dlaczego oprogramowanie (często) jest słabo udokumentowane?
Istnieje kilka dobrych przykładów dobrze udokumentowanego kodu, takich jak Java Java API. Ale wiele kodu w projektach publicznych, takich jak git i projekty wewnętrzne firm, jest słabo udokumentowane i niezbyt przyjazne dla początkujących. Na wszystkich etapach rozwoju oprogramowania miałem do czynienia ze słabo udokumentowanym kodem. Zauważyłem następujące rzeczy - Brak …
5
Projektowanie dokumentów w ramach Agile
W moim miejscu pracy stajemy przed wyzwaniem, ponieważ „zwinność” zbyt często oznacza „niejasne wymagania, złe kryteria akceptacji, powodzenia!”. Staramy się rozwiązać ten problem jako ogólny wysiłek ulepszenia. W ramach tego proponuję wygenerować dokumenty projektowe, które powyżej poziomu historii użytkownika dokładnie odzwierciedlają wyniki wstępnych badań wpływu danej funkcji w systemie i …
4
Czy BDD jest w rzeczywistości zapisywalny przez osoby niebędące programistami?
Rozwój oparty na zachowaniach z charakterystyczną składnią scenariuszy „Given-When-Then” został ostatnio podekscytowany ze względu na możliwe zastosowania go jako obiektu granicznego do oceny funkcjonalności oprogramowania. Zdecydowanie zgadzam się, że korniszon , lub jakikolwiek skrypt definicji funkcji, który wolisz, jest czytelną dla biznesu DSL i już zapewnia taką wartość. Jednak nie …
7
Zwolnić pierwszy czy najpierw dokument?
Pracuję nad projektem od kilku lat i zaczynam gromadzić porządną bazę użytkowników. Stworzyłem stronę projektu z podstawową dokumentacją, ale w tym momencie to naprawdę niewiele więcej niż FAQ. Wiem, że muszę to poprawić, aby było bardziej pouczające zarówno dla nowych, jak i zaawansowanych użytkowników, i to jest następne na mojej …
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.