Uwagi o pisaniu

Table of Contents

1. Sprawy wstępne

1.1. Cel powstania artykułu

Zakomunikowanie pewnej grupie osób wyników pewnych badań.

1.2. Przed przystąpieniem do pisania

  • Grupa docelowa:
    • Co czytelnicy wiedzą?
    • W czym są biegli?
    • O czym słyszeli?
    • Co dla nich jest nowością?
    • Czego oczekują?
  • Forma
    • Jaką liczbą stron dysponujemy?
    • Jaki poziom formalizmów jest oczekiwany?
    • Jaki poziom szczegółowości jest oczekiwany?
    • Jak dużo może być odesłań do innych prac niezbędnych do zrozumienia całości?

Uwaga: pisząc artykuł, warto pamiętać, że niezależnie od tego kto będzie faktycznym czytelnikiem, to czy artykuł się pojawi zależy od recenzentów.

  • Prace zwykle piszemy albo
    • W pierwszej osobie liczby mnogiej ("my"), nawet jeśli jest tylko jeden autor
    • albo bezosobowo

2. Struktura artykułu

2.1. Podstawowe elementy artykułu

  • Tytuł
  • opcjonalnie: Słowa kluczowe
  • Streszczenie (abstrakt)
  • opcjonalnie: Spis treści
  • Wstęp
  • Metody
  • Eksperymenty i wyniki
  • Podsumowanie i dalsze kierunki badawcze

2.2. Tytuł

  • Tytuł jest pierwszą rzeczą, z którą osoba, która przeszukuje artykuły ma styczność
  • Dobry tytuł (z punktu widzenia naukowca) powinien opisywać konkrety, które są w pracy. Takie tytuły zwykle są stosunkowo długie, np. Bazująca na algorytmie mrówkowym metoda poszukiwania strategii w grach w postaci ekstensywnej z niepełną informacją
  • Oczywiście istnieje też marketing. Tytuł takiego artykułu mógłby brzmieć: Nowa metoda do gier planszowych lub Szybka metoda do popularnych gier. Wtedy komuś, kto szuka konkretnych informacji tytuł zupełnie nie pomoże.

2.3. Słowa kluczowe

  • Część wydawnictw wymaga, aby podać słowa lub frazy kluczowe, pod którymi można będzie wyszukać pracę.
  • Wymagane może być albo:
    • Zaproponowanie własnych słów kluczowych
      • Dobrym pytaniem jest, czy w czasach wyszukiwania pełnotekstowego takie rozwiązanie ma sens.
    • Wybór słów kluczowych z podanego katalogu
      • Jednym (ale nie jedynym) powodem takiego wymagania może być wspomaganie procesu doboru recenzentów.
      • Niektóre wydawnictwa mają bardzo rozbudowane taksonomie artykułów
      • W przypadku artykułów nie mieszczących się w takich ramach zawsze jest problem

2.4. Taksonomia ACM

2.5. Streszczenie

  • Streszczenie pisane jest dla osób, które poszukują materiałów i chcą stwierdzić na ile zawartość pracy to jest to, czego oni szukają.
  • Streszczenie musi mieć sens w oderwaniu od treści. Należy przyjąć, że ktoś kto je czyta ma do dyspozycji tylko tytuł i streszczenie, a dopiero potem podejmie decyzję, czy otworzyć całą pracę.
  • Streszczenie musi w skrócie przedstawiać całość pracy.
    • To znaczy, że nie ma opowiadać jakie elementy są w pracy, czyli być zastępczym spisem treści.
    • Streszczenie ma być skrótem pracy.
  • Powyższe znaczy, że trzeba przedstawić konkretny wynik, a nie napisać, że ten wynik jest w pracy:
    • Źle: "W kolejnym rozdziale przedstawiamy wyniki eksperymentów w grach dla różnych limitów na czas obliczeń"
    • Dobrze: "W przeprowadzonych eksperymentach w szachach i warcabach metoda okazała się dużo dokładniejsza niż popularne metody, gdy czas na obliczenie ruchu jest poniżej 5 sekund."
  • Pisanie streszczeń jest zaskakująco trudne dla studentów. Będzie z tego ćwiczenie.

2.6. Spis treści

  • Ważne: spis treści następuje dopiero po streszczeniu. W ten sposób przejrzenie początkowych stron pracy wystarczy do zapoznania się z abstraktem.
  • Zwykle w artykułach nie ma spisu treści (generalnie to zależy od czasopisma). W przypadku przygotowywania dokumentu, gdzie nie ma narzuconej formy, warto zastanowić się, czy długość dokumentu faktycznie uzasadnia dodawanie kolejnych stron ze spisem treści. Niezależnie od tego, jeśli jest to forma elektroniczna, która przewiduje możliwość rozdziałów/zakładek w metadanych, zawsze warto z tego skorzystać.
  • Podobnie głębokość spisu treści (rozdziały, podrozdziały, może głębiej) zależy przede wszystkim od charakteru dokumentu.

2.7. Wstęp

  • Tu należy zawrzeć przegląd literatury (chyba, że to praca typu przegląd)
  • Wstęp ma za zadanie wprowadzić w temat. W szczególności:
    • Jak mają się treści przedstawiane w tej pracy do innych podobnych badań:
      • Kto zrobił już coś podobnego
      • Dlaczego podobne podejścia nie są wystarczające
      • Co wyróżnia to podejście spośród innych
    • Dlaczego problem jest istotny lub ciekawy
    • Definicje i oznaczenia
      • Wszelkie definicje matematyczne i oznaczenia używane w pracy powinny być wprowadzone. O ile w przypadku definicji, jeśli piszemy do grona specjalistów, którzy je znają, można podejść skrótowo, o tyle zawsze należy wprowadzić całą potrzebną notację (nawet, jeśli to najbardziej popularne oznaczenia).
    • Zapowiedź tego co będzie zrobione dalej, na przykład w formie hipotez, czy pytań badawczych.
    • Opis dalszej zawartości pracy na około 1-3 zdania.

2.8. Metody

  • Charakter tej części (i nazwy sekcji) bardzo zależą od charakteru pracy.
  • Mogą zawierać opis nowo wprowadzonej metody i analizę teoretyczną.
  • Mogą zawierać opis modyfikacji metod już istniejących
  • Mogą zawierać opis nowej techniki porównywania ze sobą metod w danym zagadnieniu albo nowe zbiory testowe

2.9. Eksperymenty i wyniki

  • Wyniki eksperymentalne są osią wielu prac z dziedziny sztucznej inteligencji.
  • Bardzo ważne jest przedstawienie całej części eksperymentalnej w sposób jasny
  • Zawsze należy w pierwszej kolejności opisać jak były przeprowadzone eksperymenty
    • Skąd były wzięte implementacje i parametry metod
    • Skąd były wzięte zbiory testowe
    • Jaki sprzęt był użyty (jeśli zasadne, jak były porównywane wyniki z wynikami starszymi, na innym sprzęcie).
    • Co było mierzone i zapisane
  • Następnie należy przedstawić wyniki, biorąc pod uwagę:
    • Jak dużo może przyjąć czytelnik. Zwykle dwie strony tabeli liczb to zły pomysł.
    • W drugą stronę: czy wyniki nie są zbyt zagregowane i agregacja nie zaciemnia przekazu
    • Czy faktycznie widoczne jest wszystko, co jest dalej omówione.
  • Omówienie wyników: oprócz przedstawienia liczb/wykresów należy zawsze omówić co zostało zaobserwowane (ale to jeszcze nie podsumowanie).

2.10. Podsumowanie i dalsze kierunki badawcze

  • To jest bardzo ważna część. Należy przyjąć, że niektórzy przeczytają abstrakt, a następnie bardzo pobieżnie spojrzą na wszystko w środku, dochodząc do konkluzji.
  • Należy przedstawić wszystkie wnioski z eksperymentów, wyjaśnienia zjawisk.
  • Potencjalne kierunki na przyszłość:
    • Co należałoby zbadać
    • Co można usprawnić

3. Bibliografia

3.1. Potrzeba zamieszczania odniesień do literatury

  • W nauce nie ma podejścia wszyscy o tym wiedzą i nie piszemy, że jakiś fakt jest oczywisty. Albo zamieszczamy dowód/uzasadnienie w treści pracy albo odnośnik do literatury, gdzie dane stwierdzenie jest podane. Jeśli to są podstawowe fakty z dziedziny, to można odnieść się do jakiegoś podręcznika, a nie do artykułu.
  • Odniesienie do literatury (cytowanie) polega na:
    • Umieszczeniu w miejscu, gdzie dany fakt/zjawisko powinien być wyjaśniony odnośnika do jakieś pracy. W pewnym miejscu pracy, zwykle na końcu, jest bibliografia i właśnie na pozycję w bibliografii wskazuje dany odnośnik.
    • Istnieją również prace, gdzie informacje bibliograficzne są w przypisach dolnych. Współcześnie w naukach technicznych to bardzo rzadkie podejście.
  • To w jaki sposób mają wyglądać odnośniki bibliograficzne, jest opisane w wytycznych redakcyjnych danego czasopisma. Mamy dwie istotnie różne grupy stylów cytowań:
    • Numeryczny – pozycje w bibliografii są ponumerowane, odnośniki do numerów.
    • Autor–rok – pozycje w bibliografii nie są ponumerowane, a odnośniki są z użyciem nazwiska autora i roku wydania pracy.
  • Formatowanie i zawartość każdej pozycji bibliograficznej też jest określone przez wytyczne redakcyjne. Pisząc prace dyplomowe zetknęliście się już z PN-ISO 690

3.2. Po co są wpisy w bibliografii

  • Wstawienie adresu url, gdzie znajduje się dana praca jest niewystarczające, materiały w Internecie szybko się przemieszczają i znikają, to może być niewystarczające
  • Każda pozycja w bibliografii powinna zawierać wystarczająco dużo informacji, żeby ją odnaleźć:
    • Sam tytuł to za mało, mogą istnieć prace o tym samym tytule, na pewno istnieją prace o bardzo podobnych tytułach
    • Tytuł+autor to nadal mało: bywa, że ktoś publikuje najpierw wstępną wersję gdzieś na konferencji, a potem rozszerzoną (z nieznacznie zmienionym tytułem) w czasopiśmie.
    • Zawsze potrzebne jest miejsce, gdzie jest praca (konferencja/czasopismo).
    • Rok wydania jest użyteczny, żeby czytelnik mógł szybko ułożyć sobie w głowie chronologię odkryć.
    • W przypadku czasopism dobrze jest podać numer wydania
    • Jeśli odnosimy się do fragmentu długiej publikacji (np. książki) to warto oprócz odnośnika do pozycji w bibliografii podać również numer rozdziału.
  • W tego typu literaturze nie stosuje się "wiszących" pozycji w bibliografii.

3.3. Unikatowe numery

Jednoznaczne identyfikowanie i katalogowanie literatury wymagało utworzenia jakiegoś rodzaju identyfikatorów.

  • Wprowadzone na przełomie lat '60 i '70 numery
    • ISBN (international standard book number), który jednoznacznie identyfikuje książkę
    • ISSN (intenrational standard serial number), który jednoznacznie identyfikuje serię publikacji (np. czasopismo)
    • Te numery wskazują na całą grupę publikacji (np. czasopismo), a nie na konkretny element
  • DOI (digital object identifier)

3.4. DOI

  • Unikatowy numer wskazujący na element znajdujący się w Internecie
  • Numer jest w postaci: doi:10.1000/182 Ukośnik oddziela prefiks od sufiksu. Prefiks jednoznacznie identyfikuje instytucję, która wydała dany obiekt, a sufiks konkretny element.
  • Numery DOI można zamienić na url wskazujący na obiekt na http://doi.org
  • Cześć będąca sufiksem nie jest ustrukturyzowana i nie musi być liczbą. Niektórzy wydawcy stosują kolejne elementy, które uszczegóławiają dany DOI
    • 10.1609/aaai.v33i01.3301970 Elementy mówią kolejno: AAAI – skrót nazwy konferencji, v33i01 – 33. edycja, tom pierwszy, 3301970 – identyfikuje konkretny artykuł
    • "obcięty" numer nie jest poprawmy doi (a przynajmniej nie musi być)
    • To jest konwencja danego wydawcy i nie każdy musi ją stosować.

3.5. Style bibliograficzne

Przykłady:

  1. APA

    Karwowski, J., & Mańdziuk, J. (2019). A Monte Carlo Tree Search approach to finding efficient patrolling schemes on graphs. European Journal of Operational Research, 277(1), 255-268.

  2. MLA

    Karwowski, Jan, and Mańdziuk Jacek. “A Monte Carlo Tree Search Approach to Finding Efficient Patrolling Schemes on Graphs.” European Journal of Operational Research, vol. 277, no. 1, 2019, pp. 255–268.

  3. Harvard

    Karwowski, J. & Mańdziuk, J., 2019. A Monte Carlo Tree Search approach to finding efficient patrolling schemes on graphs. European journal of operational research, 277(1), pp.255–268.

  4. Różnice

    Formatowanie, Zapis nazwisk. Skracanie długich list autorów, Wielkie litery w zapisie

3.6. Elementy, które często się pojawiają, chociaż tracą na znaczeniu

  • Numery stron, numery tomów. Wiele stylów bibliograficznych ich wymaga. W czasach, gdy czasopisma wychodziły w formie papierowej, każdy numer był wydawany w formie kilku oddzielnych tomów (zeszytów), żeby całościowo publikacja nie była zbyt gruba. W bibliotece na rewersie wpisywało się konkretny zeszyt, który chce się przeczytać, albo numer strony (numeracja stron między zeszytami była ciągła). Od kiedy mamy elektroniczne katalogi, tę informację można łatwo znaleźć. W publikacjach online to w ogóle nie ma znaczenia.

3.7. Narzędzia do składania tekstu

Nie jest normalne, żeby ręcznie formatować 40 pozycji w bibliografii, skoro wynaleźliśmy komputery.

  • Jeśli korzystamy z ubogich narzędzi, większość katalogów bibliotecznych i silników indeksujących pozwala nam skopiować sformatowany wpis w popularnych stylach.
  • W normalnych narzędziach wprowadzamy naszą bibliografię w formie jakieś ustrukturyzowanej bazy, a narzędzie generuje sformatowaną bibliografię. W dalszym ciągu zajęć spotkamy się z BibTeXem.

Author: Jan Karwowski, Stanisław Kaźmierczak

Created: 2021-10-22 pią 14:23