Jakie są specyfikacje techniczne? Czy są takie same jak dokumenty projektowe. Jeśli nie, jaka jest różnica i kilka
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ę...
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,...
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...
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...
Kiedy ludzie zaczęli pisać pliki Readme? Wygląda na to, że prawie wszystkie programy mają ten plik, niezależnie od formatu. Czy jest udokumentowane pierwsze użycie tego
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...
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...
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...
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...
Dlaczego w dokumentacji niektórych języków jest napisane „odpowiednik” zamiast „jest”? Na przykład, mówią Python Docs itertools.chain(*iterables) ... Odpowiednik : def chain(*iterables): # chain('ABC', 'DEF') --> A B C D E F for it in iterables: for element in it: yield...
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 w zeszłym roku . Chcę udokumentować mój...
Nie mogę policzyć, ile razy czytam stwierdzenia w duchu „testy jednostkowe są bardzo ważnym źródłem dokumentacji testowanego kodu”. Nie przeczę, że są prawdziwe. Ale osobiście nigdy nie używałem ich jako dokumentacji. W typowych ramach, których używam, deklaracje metod dokumentują ich zachowanie i...
Trochę kontrowersyjnym tematem wydaje się dokumentowanie wszystkiego, w tym składni geterów i setterów dla pól w języku „JavaBean”: ludzie mówią, że jest to niepotrzebnie długi i powtarzający się DRY (nie powtarzaj się) , że konwencja nazewnictwa powinna wszystko wyjaśniać , i zaśmieca kod /...
Obecnie piszemy specyfikacje funkcjonalne i techniczne w formacie dwóch kolumn; zdanie podsumowujące i szczegóły techniczne. Szczegóły często odnoszą się do dodatku zawierającego diagramy, projekty układów itp. Walczę jednak z tym, w jakim czasie napisać to: Z czasem przeszłym, jakby praca była...
Kontekst: Ja i moi współpracownicy piszemy artykuł do czasopisma akademickiego. W trakcie naszych badań napisaliśmy program symulacyjny w Javie. Chcemy, aby program symulacji był swobodnie dostępny dla innych. Zdecydowaliśmy się na hosting kodu w repozytorium GitHub. Aby ułatwić innym korzystanie,...
Mamy więc taki interfejs /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary>...
Czasami, choć nie często, muszę zawrzeć logikę matematyczną w kodzie. Stosowane pojęcia są w większości bardzo proste, ale wynikowy kod nie jest - wiele zmiennych o niejasnym celu i niektóre operacje o mniej oczywistych zamiarach. Nie oznacza to, że kod jest nieczytelny lub unmaintainable, tylko że...
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 . Po ponad roku pracy nad...
Jeden z deweloperów w moim zespole uważa, że konieczne jest napisanie komentarza javadoc do KAŻDEGO parametru w sygnaturze metody. Nie sądzę, aby było to konieczne, a nawet uważam, że może być szkodliwe. Po pierwsze, uważam, że nazwy parametrów powinny być opisowe i samodokumentujące. Jeśli nie...