Jak pisać? - Wydział Elektroniki, Telekomunikacji i Informatyki

Jak pisać opracowania naukowe ?
Maciej Niedźwiecki
Politechnika Gdańska
Wydzial Elektroniki, Telekomunikacji i Informatyki
Katedra Systemw Automatyki
Zasady ogólne
1. Należy używać stylu bezosobowego i/lub pierwszej osoby liczby mnogiej (pluralis
modestae, nie mylić z pluralis maiestatis):
NIE:
TAK:
“W pracy omówilem problemy (...)”
“W pracy omówiono problemy (...)”
la̧cza̧c obie zależności otrzymujemy, zalożymy że, zalóżmy że, zależność tȩ można
opisać wzorem, można wykazać że, wykazano że, stosuja̧c to przeksztalcenie
otrzymuje siȩ, otrzymane wyniki przedstawiono w tabeli, rysunki ilustruja̧ zależność
2. Należy unikać stosowania jȩzyka potocznego, żargonu i form zdrobnialych:
NIE:
TAK:
“Obliczenia trwaly strasznie dlugo (...)”
“Niestety parametry dostȩpnego żyra nie pozwalaly na (...)”
“Źródlem obrazu byla kamerka internetowa (...)”
“Obliczenia trwaly bardzo dlugo (...)”
“Niestety parametry dostȩpnego żyroskopu nie pozwalaly na (...)”
“Źródlem obrazu byla mala kamera internetowa (...)”
3. Należy unikać nadmiernej ekspresji: zdań zakończonych wykrzyknikiem, pytań i
figur retorycznych, nadmiernego podkreślania donioslości swoich wyników itp.
4. Należy dbać o czystość jȩzyka ojczystego i unikać stosowania wyrażeń
obcojȩzycznych (zazwyczaj “urobionych” od slów angielskich) tam gdzie można
użyć ich polskich odpowiedników.
Ostatni meeting tour-operatorów odbyl siȩ w Warszawie. Podczas meetingu
określono nowe targety i zaplanowano kilka eventów, które powinny przycia̧gna̧ć
do agencji turystycznych nowych klientów. Procedowano również nad określeniem
nowych destynacji ruchu turystycznego i sposobów podniesienia poziomu satysfakcji
z oferowanych uslug.
Kilka przykladów:
relatywnie tani
konwertować na postać
satysfakcjonuja̧cy
konwolucja / dekonwolucja
szybki sampling
digitalizacja
rezultaty
wykresy prezentuja̧
konwergencja
wzglȩdnie tani
zamieniać na postać
zadowalaja̧cy
splot / rozplot
szybkie próbkowanie
zamiana na postać cyfrowa̧
wyniki
wykresy przedstawiaja̧
zbieżność
5. Należy unikać stosowania nadmiernej liczby skrótów.
Komunikat NATO:
“Podczas spotkania EAPC na szczeblu DCM omówiono rezultaty NAC, gdzie
podjȩto decyzje w sprawie przeprowadzenia sesji NRC w formacie 26 plus
poświȩconej CSBM, redukcji ICSM i post-ISAF. Kontynuowano konsultacje ws.
rozmów ws. ewentualnego poszerzenia kwestii MAP w razie przeprowadzenia sesji
NGC, pod warunkiem pozytywnej oceny ANIP.”
EAPC - Euro-Atlantic Partnership Council
CSBM - Confidence and Security Building Measures
ISAF - International Security Assistance Force
6. Liczby z jednostkami miary należy zapisywać ze spacja̧, czcionka̧ wyprostowana̧:
NIE:
100kΩ, 5A, 15 mV, 40W
TAK:
100 kΩ, 5 A, 15 mV, 40 W
Uwaga: jednostki miary sa̧ zwyklymi slowami i podlegaja̧ odmianie!
Pisownia nazwisk
stala Boltzmanna
model atomu Bohra
prawa Kirchhoffa
modul Younga
przeksztalcenie Fouriera
wahadlu Foucaulta
mostek Wheatstone’a
prawo Ampere’a
algebra Boole’a
przeksztalcenie Laplace’a
prawa Joule’a
dioda Schotky’ego
Odmiana:
M
D
C
B
N
M
W
kto?
kogo (brak)?
komu?
kogo (widzȩ)?
z kim?
o kim?
o (wielki)!
Wheatstone
Wheatstone’a
Wheatstone’owi
Wheatstone’a
Wheatstone’em
Wheatstonie
Wheatstonie
Fourier
Fouriera
Fourierowi
Fouriera
Fourierem
Fourierze
Fourierze
Ampere
Ampere’a
Ampere’owi
Ampere’a
Ampere’em
Amperze
Amperze
Przypadki szczególne: z Dirakiem (nie: z Diraciem), o Laplasie, o Moorze, o
Schottkym
Czȩści skladowe artykulu naukowego
1. Tytul - powinien być precyzyjny i zwiȩzly.
2. Informacja o autorach (imiona i nazwiska autorów, miejsce ich nauki lub pracy,
adresy pocztowe, adresy elektroniczne).
3. Streszczenie - krótki (licza̧cy zazwyczaj nie wiȩcej niż 300 slów) opis celu badań,
ich metodyki, wyników i wniosków.
4. Lista slów kluczowych (ulatwiaja̧cych odnalezienie artykulu w naukowych bazach
danych).
5. Wstȩp - krótkie omówienie istoty rozważanego problemu, jego donioslości
teoretycznej i/lub praktycznej, informacja o wynikach wcześniejszych badań
dotycza̧cych rozważanych zagadnień (lub zagadnień pokrewnych). Niekiedy we
wstȩpie umieszcza siȩ również zwiȩzle omówienie treści kolejnych rozdzialów pracy.
6. Wlaściwa (merytoryczna) czȩść artykulu, podzielona na kilka rozdzialów i
podrozdzialów (np. analiza teoretyczna, opis stanowiska badawczego i metodologii
badań, prezentacja i omówienie wyników doświadczalnych i/lub symulacyjnych,
wnioski plyna̧ce z badań).
7. Podsumowanie - krótkie omówienie osia̧gniȩtych wyników (uwaga: podsumowanie
artykulu nie może być powtórzeniem jego streszczenia).
8. Bibliografia (literatura) - spis cytowanych w pracy materialów źródlowych
[ksia̧żek, artykulów i raportów naukowych, dokumentacji technicznych, odnośników
(“linków”) do stron internetowych, a czasem nawet odnośników do osobowych
źródel informacji (“private communication”)].
9. Podziȩkowania (skierowane do osób i/lub instytucji, które umożliwily
przeprowadzenie badań, udostȩpnily wyniki swoich wlasnych badań, pelnily rolȩ
konsultantów itp.)
10. Notki biograficzne autorów (tylko w niektórych czasopismach).
Zwroty, których lepiej nie używać
1. Od dawna wiadomo, że (...) - nie chcialo mi siȩ szukać pracy źródlowej.
2. (...) można dostrzec wyraźna̧ tendencjȩ(...) - trudno wycia̧gna̧ć sensowne wnioski.
3. Znalezienie ostatecznej odpowiedzi na te pytania nie bylo na razie możliwe eksperyment siȩ nie udal, ale i tak spróbujȩ opublikować wyniki.
4. Trzy spośród zestawów danych wybrano do szczególowej analizy - pozostalych 20
zestawów nie nadawalo siȩ do niczego.
5. Jest jasne, że wiele pracy należy wlożyć, zanim pelna odpowiedź stanie siȩ
możliwa - nic z tego nie rozumiem.
6. Nietrudno jest wykazać, że (...) - niestety nie wiem jak to zrobić, ale chyba mam
racjȩ.
Sposób zapisywania symboli i wyrażeń matematycznych
• Oznaczenia
skalary
wektory
macierze
a, b, c, E, F , δ, λ, σ
a, b, c, e, f , δ, λ, σ
A, B, C, E, F , ∆, Λ, Σ
• Domyślny symbol mnożenia
NIE:
w = m·g, w = m∗g, w = m×g
TAK:
w = mg
• Zapis funkcji matematycznych
NIE:
x(t) = sin(ωt), y = log(x)
TAK:
x(t) = sin(ωt), y = log(x)
• Oznaczenia wieloliterowe
NIE:
weight = mass · g
TAK:
w = mg
Wyja̧tek czynimy dla nazw funkcji matematycznych oraz skrótów, np.
(mean-squared error)
b||2]
MSE(b
x) = E[||x − x
• Nawiasy
NIE:
TAK:
E((x(t) − x
b(t))2)
2
E [x(t) − x
b(t)]
• Indeksy górne i dolne
NIE:
ẋ1(t) = a1 ∗ x1(t) + a2 ∗ x2(t)
x1new = a1 ∗ x1old + a2 ∗ x2old
TAK:
ẋ1(t) = a1x1(t) + a2x2(t)
old
xnew
= a1xold
1
1 + a2 x2
MSE
• Symbole matematyczne umieszczone w tekście powinny wygla̧dać tak samo
jak analogiczne symbole znajduja̧ce siȩ w zależnościach wydzielonych z tekstu
(numerowanych ba̧dź nienumerowanych). Wszystkie pojawiaja̧ce siȩ po raz pierwszy
symbole powinny być nazwane ba̧dź zdefiniowane.
NIE:
Rozważmy liniowy uklad dynamiczny opisany za pomoca̧ równań stanu
ẋ(t) = Ax(t) + Bu(t)
y(t) = cTx(t)
gdzie x(t) oznacza n-wymiarowy wektor stanu, u(t) oznacza m-wymiarowy wektor
pobudzeń, y(t) oznacza skalarne wyjście, zaś A, B i c sa̧ macierzami/wektorami o
wymiarach odpowiednio n x n, n x m i n x 1.
gdzie x(t) oznacza n-wymiarowy wektor stanu, u(t) oznacza m-wymiarowy wektor
pobudzeń, y(t) oznacza skalarne wyjście, zaś A, B i c sa̧ macierzami/wektorami o
wymiarach odpowiednio n x n, n x m i n x 1.
TAK:
Rozważmy liniowy uklad dynamiczny opisany za pomoca̧ równań stanu
ẋ(t) = Ax(t) + Bu(t)
y(t) = cTx(t)
gdzie x(t) oznacza n-wymiarowy wektor stanu, u(t) oznacza m-wymiarowy wektor
pobudzeń, y(t) oznacza skalarne wyjście, zaś A, B i c sa̧ macierzami/wektorami o
wymiarach odpowiednio n × n, n × m i n × 1.
(...) gdzie w dane jest zależnościa̧ w=za, w której z oznacza drugie z wymienionych
wcześniej pobudzeń, a a oznacza przyspieszenie (...)
(...) gdzie w dane jest zależnościa̧ w = za, w której z oznacza drugie z wymienionych
wcześniej pobudzeń, a a oznacza przyspieszenie (...)
• Uwaga dla użytkowników programu Word - wielkość czcionki nie powinna siȩ
zmieniać w zależności od polożenia w tekście.
• Numeracja wzorów i odnośników literaturowych
wzory/równania matematyczne - kolejne numery w nawiasach okra̧glych: (1), (2)
itd., lub kolejne numery w ramach poszczególnych rozdzialów: (1.1), (1.2), ...,
(2.1), (2.2) ... itd.
cytowane źródla bibliograficzne - kolejne numery w nawiasach kwadratowych w
kolejności, o której decyduje pierwsze odwolanie w tekście: [1], [2] itd.
• Czytelność - tekst zawieraja̧cy odnośniki i wyrażenia/wzory matematyczne musi być
zbudowany w taki sposób, aby można go bylo w sposób naturalny (tj. bez zmiany
formy gramatycznej i bez uzupelniania dodatkowymi wyrazami) odczytać na glos.
NIE:
W [1] Einstein wykazal że
E = mc2
gdzie:
m
c
-
masa spoczynkowa ciala
prȩdkość światla w próżni
Z (1) wynika, że (...)
(1)
TAK:
W pracy [1] Einstein wykazal że
E = mc2
(2)
gdzie m oznacza masȩ spoczynkowa̧ ciala, zaś c - prȩdkość światla w próżni. Z
zależności (2) wynika, że (...)
• Wyliczenia - sformulowana wyżej zasada czytelności obowia̧zuje również w
przypadku wyliczeń.
Użyty w pracy mikrofon ma nastȩpuja̧ce parametry:
-
impedancja wejściowa: 10 Ω,
poziom znieksztalceń nieliniowych: 1%,
jest wielokanalowy
waży 500 g
• Odnośniki do wzorów - nie stosujemy odnośników “w przód”.
Zapożyczenia
• Zapożyczony tekst należy umieścić w cudzyslowie (“...”) i podać jego źródlo,
niezależnie od tego, czy jest to ksia̧żka, artykul lub raport, czy strona internetowa
(np. informacja pochodza̧ca z Wikipedii).
• Nie wolno przesadzać z dlugościa̧ przytaczanych fragmentów.
• Z uwagi na anonimowość i brak pelnych mechanizmów sprawdzaja̧cych, źródla
internetowe uważane sa̧ za niepewne.
Uwaga na Wikipediȩ! Przez 15 miesiȩcy na stronach polskiej edycji Wikipedii można
bylo znaleźć artykul o fikcyjnym dzialaczu robotniczym, czlonku Komunistycznej
Partii Polski, Henryku Batucie. Dane pochodza̧ce z tej notki biograficznej znalazly
siȩ w kilku obronionych pracach magisterskich i doktorskich ...
Kilku podobnych prowokacji dopuszczono siȩ na stronach anglojȩzycznej wersji
Wikipedii (por. np. historia pirata Edwarda Owensa).
Literatura
[1] S.V. Vaseghi, Advanced Signal Processing and Digital Noise Reduction, Wiley,
1996.
[2] J.S. Godsill, J.P.W. Rayner, Digital Audio Restoration, Springer-Verlag, 1998.
[3] D. Ureń, Opus Mea, PWN, 2001.
[4] S.V. Vaseghi, R. Frayling-Cork, “Restoration of old gramophone recordings,” J.
Audio Eng. Soc., vol. 40, str. 791–801, 1992.
[5] A.B. Kowalski, C. Malinowski, “Krótka teoria wszystkiego”,
https://bezsensu.com.
[6] S.J. Godsill, P.J.W. Rayner, “A Bayesian approach to the restoration of degraded
audio signals,” IEEE Trans. Speech, Audio Process., vol. 3, str. 267–278, 1995.
[7] C. Bao, P. Sas, H. Van Brussel, “Comparison of two on-line identification
algorithms for active noise control,” in Proc. Recent Advances in Active Control
of Sound and Vib., Blacksburg, VA, USA, 1993, str. 38–51.
[8] X. Guo, M. Bodson, “Adaptive rejection of multiple sinusoids of unknown
frequency,” in Proc. European Control Conference, Kos, Greece, 2007, str.
121–128.
Korekta
• Przed oddaniem/wyslaniem starannie przeczytać, najlepiej w wersji “papierowej”.
• Dać do przeczytania
-
siostrze / bratu
dziewczynie / chlopakowi
mamie / tacie
psu / kotu (pod warunkiem, że potrafia̧ czytać)
• Odlożyć na jakiś czas i przeczytać ponownie.
• Sprawdzić poprawiony fragment tekstu bezpośrednio po wprowadzeniu poprawek
(dotyczy to zwlaszcza użytkowników edytora LaTeX).
• Korzystać z podpowiedzi edytora tekstu.
Z uwagi na silne zaklucenia w toże wyjściowym, conajmniej dwa z zarejestrowanych
sygnalów okazaly siȩ bezurzyteczne i wogóle nie byly rozpatrywane ...
LaTeX czy Word ?
Rada prowadza̧cego - zdecydowanie LaTeX. LaTeX (czytaj “latech”) jest
zaawansowanym edytorem tekstu stworzonym dla potrzeb skladania tekstów
matematycznych i technicznych. Studenci WETI maja̧ dostȩp do darmowej wersji
edytora.
Zalety edytora LaTeX to:
• Profesjonaly wygla̧d skladu (dobór odstȩpów, rozlożenie materialu na stronie,
wygla̧d wyrażeń matematycznych, zwlaszcza tych o wysokim stopniu zlożoności) systematycznie rośnie liczba czasopism naukowych, które do skladu używaja̧ edytora
TeX (rozbudowana wersja LaTeX’a).
• Automatyczna numeracja wzorów rysunków i tablic.
• Automatyczne formatowanie bibliografii.
• Rozbudowany i wygodny w użyciu modul sprawdzanie pisowni.
Czego nie wolno robić - naruszenia zasad etyki zawodowej
• Zglaszanie artykulu do druku jednocześnie w kilku czasopismach.
• Zglaszanie referatu jednocześnie na wiele konferencji.
• Plagiat i autoplagiat.
• Tendencyjny wybór danych i/lub ich fabrykowanie (Jacques Benveniste - “pamiȩć
wody”, Stanley Pons i Martin Fleischmann - “zimna fuzja”, Andrew Wakefield “szczepionki przyczyna̧ autyzmu u dzieci”, Hwang Woo-Suk - “klonowanie komórek
macierzystych”). Wszystkie wyniki zamieszczone w pracy powinny być możliwe do
odtworzenia przez innych badaczy (principle of reproducible research).
• Wykorzystywanie ludzi ba̧dź zwierza̧t w badaniach doświadczalnych w sposób
niezgodny z obowia̧zuja̧cymi normami etycznymi - brak pisemnej zgody na
przeprowadzenie badań, brak powiadomienia o ewentualnych zagrożeniach,
powiklaniach itp., prowadzenie badań, które sa̧ źródlem cierpień fizycznych lub
psychicznych.
• Spis autorów niezgodny ze stanem faktycznym (np. pominiȩcie jednego lub kilku
autorów).
Warto wiedzieć:
Nicolas Bourbaki to pseudonim grupy francuskich matematykẃ (w sumie bylo ich
18), którzy w roku 1935 zalożyli dzialaja̧ce przy Ecole Normalle Superieur w Paryżu
stowarzyszenie Association des Collaborateurs de Nicolas Bourbaki. Czlonkowie
grupy opublikowali pod przybranym pseudonimem wiele ważnych prac budza̧c
podziw i zazdrość w środowisku matematyków.
Przelomowy artykul dotycza̧cy sekwencjonowania ludzkiego genomu (DNA
czlowieka) pt. “Initial sequencing and analysis of the human genome”, który
ukazal siȩ w czasopismie Nature w roku 2001, ma okolo 2900 autorów (w
wersji “papierowej” czasopisma wymieniono tylko kilkuset spośród nich - pozostale
nazwiska podano w internetowej wersji artykulu).
W roku 2013 w czasopismie Physics Review ukazaly siȩ dwa 30-stronicowe artykuly
naukowców z CERN poświȩcone bozonowi Higgsa (nazywanemu “boska̧ cza̧stka̧”).
La̧czna lista autorów obu artykulów zajmuje 19 stron druku i zawiera okolo 6000
nazwisk.
Notowania czasopism na “rynku” naukowym
Instytut ISI (Institute of Scientific Information), zwany popularnie Instytutem
Filadelfijskim, jest komercyjna̧ instytucja̧ naukowa̧, bȩda̧ca czȩścia̧ koncernu
prasowego Thomson Reuters Corporation z siedziba̧ w Filadelfii, zajmuja̧ca̧ siȩ
gromadzeniem, przetwarzaniem i udostȩpnianiem różnego rodzaju naukowych baz
danych m. in.
• ISI Web of Science
• ISI Citation Index
• ISI Journal Citation Reports
Lista filadelfijska (ISI Master Journal List) - lista czasopism naukowych opracowana i
aktualizowana przez Instytut ISI (okolo 8300 pozycji).
2-year IF, 5-year IF
IF = impact factor (wspólczynnik wplywu, miara oddzialywania)