PROCES TWORZENIA DOKUMENTU 1. PLANOWANIE 2. ANALIZA ASPEKTÓW PRAWNYCH I ETYCZNYCH 3. GROMADZENIE INFORMACJI 4. ORGANIZOWANIE (STRUKTURALIZOWANIE) INFORMACJI 5. TWORZENIE PLANU (STRUKTURY) DOKUMENTU 6. TWORZENIE TEKSTU 7. WŁĄCZANIE ELEMENTÓW GRAFICZNYCH 8. FORMATOWANIE 9. SPRAWDZANIE I POPRAWIANIE 11.1
SPRAWDZANIE I POPRAWIANIE - POZIOMY SPRAWDZANIE I KOREKTA TREŚCI sprawdzanie: - przez autora - przez kolegę (peer review) - przez osobę z wyższego poziomu SPRAWDZANIE I KOREKTA ORGANIZACJI SPRAWDZANIE I KOREKTA STYLU I FORMY z praktyki dużych firm przy układaniu harmonogramu zakłada się, że poprawianie zajmuje 30-40% czasu tworzenia dokumentu 11.2
SPRAWDZANIE TREŚCI jasno zdefiniowany cel dokumentu treść dokumentu opowiadająca zdefiniowanemu celowi zawartość informacyjna i poziom rozważań dostosowane do odbiorcy (system pojęciowy, poziom szczegółowości wyjaśnień - definicje, opisy, przykłady) samowystarczalność (self-contained document) przedstawienie kontekstu rozważań (przegląd literatury w publikacjach naukowych itp.) udokumentowanie źródeł informacji (odpowiednie i dostatecznie aktualne źródła) stwierdzenia i wnioski poparte faktami wyraźnie wyróżniony wkład własny autora (w publikacjach naukowych itp.) 11.3
SPRAWDZANIE TREŚCI (cd.) krótki, informacyjny tytuł dokumentu, odpowiadający jego treści informacyjny abstrakt (streszczenie) odpowiednia zawartość treściowa części początkowej (wstęp) i części końcowej (zakończenie); zgodność z celem brak treści nadmiarowych (wykraczających poza zakres tematyczny) i powtórzeń wykorzystanie rozważań wstępnych (teoretycznych) w zasadniczej części dokumentu 11.4
SPRAWDZANIE TREŚCI (cd.) An article is finished not when there is nothing more to add, but when there is nothing more that can be taken away. [IEEE Software, cytat z Woltera] 11.5
SPRAWDZANIE ORGANIZACJI logiczna struktura dokumentu widoczna na pierwszy rzut oka względna długość poszczególnych części (rozdziałów) opowiadająca ważności i zakresowi omawianych zagadnień właściwe (dostosowane do treści) i łatwo identyfikowalne struktury informacji w poszczególnych częściach (na różnych poziomach organizacji) dokumentu krótkie, informacyjne tytuły rozdziałów (podrozdziałów), odpowiadające ich zawartości zgodność gramatyczna tytułów rozdziałów (podrozdziałów) na danym poziomie organizacji dokumentu 11.6
SPRAWDZANIE ORGANIZACJI (cd.) łagodne przejście pomiędzy kolejnymi fragmentami tekstu (rozdziałami, podrozdziałami, akapitami) - związek logiczny i sformułowania separacja logiczna tytułów i treści rozdziałów (podrozdziałów, punktów) łatwość znalezienia poszukiwanej informacji - odpowiednie zestawienia (spis treści, skorowidz,...), nagłówki, wyróżnianie fragmentów tekstu,... 11.7
SPRAWDZANIE ORGANIZACJI (cd.) odpowiednia liczba i zawartość informacyjna elementów graficznych właściwy rodzaj każdego z elementów graficznych (tabela czy wykres, wykres słupkowy czy wykres kołowy itp.) odpowiednie powiązanie logiczne tekstu z elementami graficznymi - odwołania, interpretacja danych itp. niewrażliwość powiązania tekstu z elementami graficznymi na formatowanie dokumentu 11.8
SPRAWDZANIE STYLU ton (styl wypowiedzi) dopasowany do odbiorcy zwięzłość tekstu czytelność tekstu - proste konstrukcje zdaniowe odpowiednia długość i logiczna konstrukcja akapitów wykorzystanie list zgodność gramatyczna pozycji na listach, a także - w pewnym zakresie - podpisów pod rysunkami i tabelami poprawność gramatyczna precyzyjne definicje pojęć właściwe słownictwo - precyzja oraz brak żargonu, eufemizmów, modnych słów-wytrychów itp. skróty wyjaśnione przy pierwszym użyciu poprawna ortografia - pisownia wyrazów, wielkość liter, interpunkcja kompletność opisu pozycji bibliograficznych 11.9
SPRAWDZANIE STYLU (cd.) AUTOMATYCZNE SPRAWDZANIE I KOREKTA? korekta pisowni - dobra skuteczność (choć nie wykrywa wszystkich błędów) sprawdzanie poprawności gramatycznej oraz czytelności - ograniczona skuteczność PROBLEM OBCEGO JĘZYKA w znacznym stopniu jest problemem niedostatecznych umiejętności w posługiwaniu się językiem ojczystym 11.10
SPRAWDZANIE FORMY FORMĘ OKREŚLAJĄ wymagania zewnętrzne (narzucone przez wydawcę, stosowane w firmie) ogólne zasady formatowania dokumentów 11.11
SPRAWDZANIE FORMY (cd.) odpowiednia długość odpowiednie marginesy odpowiednie odstępy (biała powierzchnia) odpowiednia liczba kolumn i długość linii odpowiedni układ tekstu na stronie (niewystępowanie pojedynczych linii na końcu strony itp.) odpowiednie rozmieszczenie elementów graficznych elementy graficzne opracowane zgodnie z zasadami ich tworzenia podstawowy rodzaj, rozmiar czcionki i interlinia dopasowane do rodzaju dokumentu, odbiorcy,... odpowiednie wyróżnianie fragmentów tekstu - właściwe sposoby, umiar i konsekwencja odpowiednie używanie kolorów - umiar i konsekwencja 11.12
ROZSĄDEK PONAD WSZYSTKO Wytyczne i wskazówki sformułowane w postaci suchych reguł ale Nie powinny być traktowane jako dogmat Intencja: Zwrócić uwagę autora na pewne kwestie NAJWAŻNIEJSZY JEST ZDROWY ROZSĄDEK! 11.13