Ortografia, interpunkcja, gramatyka, formatowanie

Ortografia, interpunkcja, gramatyka, formatowanie – wszystkie te elementy są ważne. Nawet jeśli od tekstu technicznego wymagamy przede wszystkim: prawdziwości, zasadności, ścisłości i komunikatywności, to tekst z błędami językowymi lub niedbale sformatowany nie budzi zaufania (jego prawdziwość jest wątpliwa), może  negatywnie nastawić czytelnika do treści tekstu lub autora i niepotrzebnie skupia uwagę na niepoprawnych formach wypowiedzi, zamiast na komunikowanej treści.

Aby uniknąć problemów jak w przykładzie powyżej dobrze jest korzystać ze słownika i, ważne, przed wysłaniem dokumentu uważnie go przeczytać, najlepiej w pewnym odstępie czasowym od ukończenia pracy.


Drobiazgi:
  • iteracje, kroki algorytmu są policzalne i mówimy o ich liczbie a nie ilości, a więc liczba iteracji, liczba kroków
  • znaki: - (dywiz) i – (półpauza) różnią się od siebie i należy ich używać świadomie (dłuższy opis zob. na przykład tutaj)
  • jeśli mówimy o pobieraniu danych z wejścia, to odpowiednim słowem będzie "wczytywanie". 

Komentarze

  1. Mateusz Karnicki9 marca 2024 09:52

    Link odnoszący się do użycia półpauz oraz dywiz, wygasł

    OdpowiedzUsuń

Prześlij komentarz

Popularne posty z tego bloga

Jak nie robić wykresów?

Obraz
Format wektorowy Osadzenie wykresu w dokumencie zwykle nie stanowi żadnego problemu. Proszę jednak zwracać uwagę na format. Wstawienie wykresu jako bitmapy zwykle skutkuje deformacjami przy skalowaniu i brzydkim wyglądem jak w przykładzie poniżej.    Skala Jeśli na wykresie chcemy umieścić znacznie różniące się dane, to pomocne może być użycie skali logarytmicznej.  Pozostawiając skalę liniową możemy doprowadzić do sytuacji, w której większość danych nie przedstawia na wykresie żadnej wartości, gdyż wszystkie punkty znajdują się na jednym poziomie i czytelnik nie jest w stanie ich odczytać. W powyższym przykładzie wykres pokazuje trend płaski aż do wartości około 25, gdzie zaczyna się szybki wzrost. W istocie,  błąd w całym zakresie osi poziomej rośnie prawie równomiernie i byłoby to widoczne, gdyby na osi pionowej ustawiono skalę logarytmiczną . Opis osi Osie wykresu powinny być opisane w taki sposób, aby czytelnik miał szansę odczytać wykres be...
Czytaj więcej

Długość sprawozdania nie jest wartością samą w sobie

Obraz
Najpierw cytat: "Je n'ai fait celle-ci plus longue que parce que je n'ai pas eu le loisir de la faire plus courte"  (List ten jest tak długi tylko dlatego, że nie miałem czasu go skrócić) - miał napisać Blaise Pascal w jednym ze swoich listów . Proszę pamiętać, że sprawozdanie piszemy zwykle po to, żeby zaoszczędzić komuś czas, a więc szanujmy czas i uwagę czytelnika. Pytanie pomocnicze: jaka jest wartość sprawozdania, jeśli jego przeczytanie i zrozumienie zajmuje więcej czasu niż praca, którą dokument opisuje? W szczególności proszę pamiętać, że długie ciągi cyfr są mało czytelne i szczegółowe dane zwykle wystarczy dołączyć wraz z wynikami eksperymentu lub programem, który je generuje.  W przykładzie powyżej autorowi mogło chodzić o przedstawienie różnic pomiędzy metodami obliczania wartości zadanej funkcji. Czy nie lepiej było odjąć je od siebie błędy i przedstawić wartości różnic? Może lepiej na wykresie? Co jest istotnego w tym konkretnym argumencie, czy ...
Czytaj więcej

O czym nie zapomnieć na początku?

Obraz
Na początku sprawozdania podajemy czego dokument dotyczy, dane autorów oraz datę utworzenia. O ile przeważnie nie napotykam problemów z brakiem tytułu i podpisu, to brak daty jest dość częsty. Nie jest to problem dyskwalifikujący, ale jej podanie ma charakter porządkujący i może stanowić ułatwienie również dla samego autora zwłaszcza wtedy, gdy sprawozdanie było poprawiane i powstało kilka jego wersji. W przykładzie poniżej zamalowane pole zawierało podpis wraz z numerem indeksu (dobrze), ale bez podania grupy studenckiej i terminu zajęć (utrudnienie przy sprawdzaniu). Ponadto, tytuł składa się z dwóch członów: "Metody numeryczne" oraz "Projekt 1", które mogłyby być graficznie rozdzielone, np: umieszczone w osobnych liniach.
Czytaj więcej