Po prostu nie wyobrażam sobie pisania oprogramowania bez specyfikacji. Bez względu na to, jak szkicowy lub na wysokim poziomie, specyfikacja jest ważna, aby wyjaśnić programistom bez wiedzy o tym, jakie są funkcje programu.
Problem polega jednak na tym, że jest to obywatel drugiej kategorii w całym cyklu tworzenia oprogramowania; kiedy rozwój odbiera parę, jest zaniedbywany. Ale gdy pojawią się spory, programiści, testerzy i sprzedawcy będą starali się znaleźć specyfikację uzasadniającą ich podstawy.
Stanie się co najmniej jeden scenariusz:
- Specyfikacji nie można odzyskać, nikt nie wie, gdzie jest specyfikacja
- Różne wersje specyfikacji pochodzą z różnych źródeł; trudno jest ustalić, która wersja jest najnowszą wersją lub czy dostępna jest najnowsza wersja.
- Specyfikacja jest niekompletna, brakuje niektórych części dokumentów, do których się ona odnosi.
Dlatego zarządzanie specyfikacjami jest ważne i równie ważne jest to, że każdy ma tylko jedno pojedyncze źródło specyfikacji.
Jak zarządzasz specyfikacjami? Próbowałem zachęcić wszystkich do korzystania z Dokumentów Google, ale wszyscy wyrazili sprzeciw. Wszyscy są zbyt przywiązani i zakochani w programie Microsoft Word, który - ich zdaniem - jest bardzo łatwy w użyciu, bardzo łatwo wstawić obraz, bardzo łatwo wpisać równanie i tak dalej.
Jak przekonać ich, że udostępnianie MS Word jest po prostu okropne?
źródło
Nie sądzę, że jest to kwestia „narzędzia”, ale raczej kwestia „procesu” (lub braku procesu).
Prawdopodobnie masz już proces wydania oprogramowania (test jednostkowy, test integracji, list wydania, dostawa itp.), Musisz również wdrożyć proces dokumentacji.
źródło
Pewien rodzaj kontroli jest zdecydowanie wymagany.
Musi być wersjonowany i podpisany, a proces ten musi być rygorystyczny.
W zbyt wielu miejscach wypisywanie się jest zaniedbywane, a to prowadzi do walk z bułkami.
Lokalizacja nie ma znaczenia, o ile można ją śledzić
Ale co ważniejsze, musisz zaangażować wszystkie zaangażowane osoby oraz 1 lub 2 osoby, które są odpowiedzialne za zarządzanie zarówno dokumentem, jak i podpisaniem go np. kierownik projektu.
źródło
MS Word doskonale nadaje się do tworzenia specyfikacji. Zarządzamy naszą w SharePoint, który obsługuje również wersjonowanie. Jeśli nie masz pod ręką SharePoint lub innego produktu do zarządzania dokumentami, Dokumenty Google są w porządku (możesz teraz przesyłać pliki .doc / .docx bez konwersji ich do formatu Dokumentów Google). Lub, jak sugerują inni, możesz nawet przechowywać je w systemie kontroli wersji kodu źródłowego (jeśli osoby tworzące specyfikacje mają dostęp do tego systemu).
źródło
nie można łatwo porównać, jaka jest różnica między dwoma instancjami w systemie kontroli wersji.
Z tego powodu nie lubię specyfikacji słów. Ale ponieważ jest to polityczna decyzja o użyciu specyfikacji słów, mamy jako pierwszą stronę „informacje historyczne” z tymi kolumnami:
numer wersji (dotyczy weryfikacji produktu), autor, data, opis
źródło