piątek, 10 października 2008

W czym pisać "poważny artykuł" i jak to robić w grupie?

Zanosi się na to, że praca magisterska będzie dla mnie projektem grupowym. Właśnie w dwuosobowym zespole przechodzimy pierwsze szlify, a to u mnie zawsze oznacza wybranie zabawek do skrzynki narzędziowej.

Z raportami / artykułami pojawia się parę problemów:

  • Zarządzanie bibliografią
  • Zarządzanie odniesieniami do bibliografii, figur, tabel etc.
  • Dbanie o wygląd całości
  • Dbanie o zgodność wyglądu i struktury z narzuconymi wymaganiami

Zajmowanie się poprawnością zarówno merytoryczną jak i wizualną jest męczące, a współczesne procesory tekstu wcale nie poprawiają tutaj sytuacji. Mimo zaawansowanych opcji do pracy grupowej jak porównywanie wersji, komentarze i rozwiązania do tworzenia linków, tabel, spisów treści, bibliografii i obsługi stylu... zawodzą. Jeśli artykuł jest krótki i zmiany wprowadzane są we względnie dużych odstępach czasu, to najbardziej znane oprogramowanie może się sprawdzić, a różne wersje można przesyłać mailem i korzystać z opcji ich porównania i komentarzy. W taki sposób pisałem ostatni "poważny" artykuł i poza problemem z trzymaniem się szablonu (który przychodził z własnymi makrami do formatowania) innych tym razem nie było.

Jednak dalej nie wszystko mi pasowało, więc przy kolejnej okazji spróbowałem czegoś innego. Informatyka twierdzi, że "Separation of Concerns" jest dobre, tak więc warto przetestować to i w tym wypadku.

Ostatecznie pudełko składa się z:

  • LaTeX + BibTex
  • SVN + Trac
  • Eclipse + Texlipse + ECF (Cola) + Subversive
  • Lyx

Wybór LaTeX-a pozwala zapomnieć o problemach zgodności z szablonem, właśnie dzięki oddzieleniu zawartości od opisu wyglądu. Wyglądu zwykle się tu nie opisuje ale znajduje odpowiednią klasę (na 95% jeśli gdzieś wymagają zgodności z szablonem od informatyka, to istnieje odpowiednia klasa LaTeX). Trzeba poświęcić odrobinę czasu by nauczyć się LaTeX-a, ale by prawidłowo używać współczesnego edytora tekstu trzeba go nie mniej. BibTex pozwala mi trzymać wszystkie referencje z każdej pracy w jednym miejscu. Referencje są tworzone tylko do tych źródeł,  które rzeczywiście w aktualnej pracy używam. W każdej pracy są wyświetlane stosownie do wymaganego stylu. SVN pozwala na wygodną pracę grupową z porządną historią wersji, a LaTeX jako plik tekstowy idealnie się nadaje do wrzucenia na SVN. Trac z kolei pozwala na zarządzanie SVN, tworzenie planu i prowadzeniem wiki. Na naszym wiki pojawiły się definicje i opisy, które nie trafiły do aktualnego dokumentu, zbieramy wszystko co może nam się przydać w przyszłości w jednym, bardzo wygodnym miejscu. Wybór Texlipse pozwala na integrację edytora do LaTeX-a z SVN, jednocześnie z dodatkiem ECF można niektóre zmiany dyskutować na "żywo" (więcej [tutaj]). Czasem przeglądanie czystego TeX-a męczy, więc do przeglądu i poprawek używam Lyx, który na bieżąco edytuje przybliżony podgląd dokumentu jednocześnie nie pozwalając na nieprawidłowe formatowanie.

W efekcie otrzymuje się profesjonalnie wyglądający i po prostu ładny dokument.