Narzędzie typu Wiki do pisania specyfikacji i dokumentacji [zamknięte]

9

Szukam systemu wiki lub podobnego do wiki systemu do pisania i zarządzania specyfikacją i dokumentacją projektu oprogramowania.

Wiem, że dostępnych jest wiele implementacji wiki, ale czy są takie, które są szczególnie odpowiednie do tego rodzaju zadań?

W rzeczywistości nie musi to być wiki, tylko system, który ułatwia pisanie i nawigowanie po specyfikacjach i dokumentacji oraz obsługuje śledzenie zmian.

użytkownik35746
źródło
1
Czy korzystasz ze specjalnej platformy? Jak na przykład TFS Microsoftu?
Saeed Neamati,
Zgodnie z pytaniem @Saeed, jaki rodzaj infrastruktury ma już Twój zespół / organizacja do zarządzania wiedzą i dzielenia się nią? Jakie są twoje obecne procesy pisania specyfikacji i dokumentów?
Thomas Owens

Odpowiedzi:

6

Używamy LaTeX i SVN. Ponieważ dokumenty LaTeX są tylko plikami tekstowymi, dobrze gra z kontrolą wersji, w przeciwieństwie do niektórych formatów binarnych lub częściowo binarnych.

Otrzymujesz wszystkie zalety (i wady, co prawda) kontroli wersji, do której jesteś przyzwyczajony, gdy używasz jej z kodem.

LaTeX wymaga trochę konfiguracji (aby zdefiniować własny styl / klasę), ale kiedy już to zrobisz, jest to bardzo dobre - możesz skoncentrować się wyłącznie na treści, a nie na jej prezentacji (zamiast pokusić się o ciągłe dostosowywanie, jak to robisz) WYSIWYG), ale wciąż otrzymujesz elegancki, profesjonalnie wyglądający dokument PDF na końcu.

Scott
źródło
4

Osobiście bardzo lubię Tiddly Wiki .

Ma dość kompletną składnię wiki, jest samodzielnym pojedynczym plikiem HTML i działa dobrze z różnymi przeglądarkami internetowymi bez potrzeby korzystania z serwera.

Ma nawet rozszerzalną architekturę wtyczek, która pozwala dodawać wtyczki w celu wykonywania różnego rodzaju interesujących rzeczy, takich jak szyfrowanie piskląt lub dodawanie przypisów.

Mark Booth
źródło
3

W przypadku platformy Microsoft integracja TFS (Team Foundation Server) z SharePoint jest właśnie tym, czego szukasz. Tworząc nowy projekt zespołowy, możesz wybrać szablon obejmujący prawie każdy aspekt procesu tworzenia oprogramowania. Daje portal, w którym możesz definiować członków zespołu, przypisywać im role i uprawnienia bezpieczeństwa, przesyłać, udostępniać i edytować dokumenty i specyfikacje związane z projektem oraz robić z nim wiele innych fajnych rzeczy.

Na innych platformach myślę, że możesz użyć czegoś takiego jak GitHub (choć nie jestem tego pewien).

Saeed Neamati
źródło
0

Do osobistego projektu (istniejącego tylko na moim komputerze) używam Wiki w słoiku . W przeszłości pracowałem z Redmine (ma ponadto system śledzenia błędów i SCM)

alepuzio
źródło
0

Możesz wypróbować Sphinx z dokumentami wpisanymi do wybranej infrastruktury zarządzania kontrolą źródła. Ma to zalety kontroli źródła i stosunkowo lekkiego języka znaczników, reStructuredText , który jest łatwy do nauczenia i dość dobrze przygotowany do konwersji (do HTML, do PDF itd.).

asthasr
źródło