Paweł Goleń, blog

Tworzenie raportu z testów nie jest odkrywcze. Odkrywcza była faza, która tę przykrą czynność poprzedzała. Raport ma ustaloną strukturę, powinien zawierać podsumowanie dla kadry zarządzającej (w praktyce jedyny element, który ta kadra czyta), bardziej szczegółowe podsumowanie dla kadry technicznej, opis przedmiotu testów, wykonanych działań, metodyki (o ile taką można sensownie określić), a następnie szczegółowy opis znalezionych podatności, który z kolei powinien zawierać:

• Opis podatności,
• Określenie zagrożenia,
• Określenie ryzyka,
• Wskazanie środków naprawczych,

Ogólnie raport posiada wyraźną formę i tak naprawdę sam dokument może być generowany automatycznie, oczywiście na podstawie wcześniej wprowadzonych danych. Pozwoliłoby to oddzielić dwie sprawy - treść (wartości merytoryczne) od sposobu jej prezentacji i na podstawie wprowadzonych danych - generować raport o oczekiwanym, profesjonalnym formacie. Cóż, dla mnie liczy się przede wszystkim treść, dla odbiorcy, zwłaszcza tego, który swoją przygodę z raportem zakończy na przeczytaniu, co najmniej tak samo istotna, jeśli nawet nie bardziej, jest forma. Sprawy tak niezrozumiałe dla mnie, jak kompozycja tekstu, dobór formatowania, umiejętne podkreślenie niektórych istotnych fragmentów, nabierają kluczowego znaczenia. No może przesadzam z tą niezrozumiałością, dla mnie też istotne jest, by to, co czytam wyglądało jakoś sensownie, było czytelne, by najważniejsze elementy łatwo dały się wyłowić z treści. Być może ktoś uzna to, za iście na łatwiznę, ale ja się z tym nie zgodzę. Czas na analizę tego, co autor miał na myśli może mogą poświęcać humaniści, ale nie osoby techniczne w odniesieniu do spraw technicznych właśnie. Oczywiście, nawet tu wkracza psychologia i odpowiednie formatowanie tekstów jakoś się nazywa, zostało ubrane w ładne teorie, niestety, w tej chwili po prostu wyleciało mi to z głowy, ktoś pamięta jak? Koncept "generatora raportu" doczekał się nawet implementacji, jako projekt OWASP. Narzędzie, które nazywa się, niespodzianka, OWASP Raport Generator jest niestety wciąż w stanie, który nie nadaje się do użytku... W chwilach desperacji myślałem o szybkim napisaniu własnego narzędzia, ale jest jedna przeszkoda - raporty nie są pisane jednoosobowo. Sam od biedy przeżyłbym klepanie raportu w XML i następnie przekształcanie ich przy pomocy XLST, ale marnie widzę zastosowanie tego sposobu pracy w większej grupie. W rezultacie na razie skazany jestem na używanie edytora tekstu i... i sporo czasu muszę spędzać na walkę z nim...

Używam OpenOffice, który spełnia większość moich wymagań. Jeśli ktoś jednak twierdzi, że można bez problemów edytować dokumenty i współpracować z użytkownikami Microsoft Office, to nie wie, co mówi. Owszem, można, ale współpraca na pewno nie jest bezproblemowa... Nawet jeśli te problemy się przeskoczy, jest kolejna rzecz, która irytuje mnie niemiłosiernie. Przyciski związane z formatowaniem (pogrubienie, pochylenie, podkreślenie, edycja kroju czcionki i jej wielkości, wcięcia) powinny zniknąć z paska edytorów tekstu. To, co się otrzymuje w rezultacie, to sieczka. Sieczka, która może być akceptowalna, gdy dokument tworzy jedna osoba. Gdy tych osób jest wiele, to otrzymuje się niespójną sieczkę, której w żaden sposób nie można ogarnąć. Nie ma co ukrywać, w moim środowisku (osób technicznych) nie ma wielu "wirtuozów MS Office" i dobra sekretarka pobiłaby mnie i moich znajomych na głowę w wykorzystaniu Worda czy Excela. Dlatego sieczka w naszym wykonaniu jest naprawdę najwyższej jakości... Dlatego jedynym sposobem formatowania tekstu, który powinien być wykorzystany, to style i to bez znaczenia, czy korzysta się z Microsoft Word, czy OpenOffice Writer...

Definiując odpowiednie style, a następnie konsekwentnie ich używając, otrzymuje się spójny wizualnie dokument, który może sprostać wymaganiom tego, czego nawy zapomniałem. Co ważniejsze, przy tworzeniu raportu (część merytoryczna) można oderwać od tego, jak to będzie później wyglądać. Owszem, trzeba już w tej chwili sensownie dzielić bloki tekstu i przypisywać różnym (logicznie) elementom dokumentu (i nie chodzi tylko o klasyczny podział na nagłówki, listy, tabele i tekst) oddzielne style, to, jak poszczególne elementy będą wyglądać, można określić jednak później.

...może kiedyś będzie więcej...

//EDIT

Nie dawało mi to spokoju. Ostatecznie przez pojęcia mind mapping, information mapping (i kilku wycieczkach w tematy pokrewne) dotarłem do celu - Structured Writing, o to mi chodziło :)