TeamQuest Blog

Dlaczego warto tworzyć pliki READ_ME.MD?

Dlaczego warto tworzyć pliki READ_ME.MD?

TeamQuest 12.01.2018 r.

Markdown to język znaczników, pomocny przy tworzeniu i prowadzeniu dokumentacji projektów, który stał się wśród programistów praktycznie standardem w dokumentowaniu kodu. Nieodłącznym elementem projektu wykorzystującego język Markdown jest jego dokument opisowy, który może stać się wizytówką naszego projektu oraz punktem zwrotnym dla jego dalszego jego rozwoju.

Zrób dokumentację projektu dla innych

Samo stworzenie i upublicznienie kodu nie jest równoznaczne z tym, że nagle zaczną z niego korzystać programiści na całym świecie. Bez stworzenia dokumentacji projektu ciężko będzie przyciągnąć do niego ludzi. To właśnie w zamieszczanym najczęściej katalogu głównym projektu pliku READ_ME przedstawić przeznaczenie kodu oraz podać instrukcję jak z niego korzystać. Jeżeli upubliczniasz swój projekt w platformie open source, zapraszając tym samym do uczestnictwa w jego rozwoju innych programistów, to właśnie dzięki informacjom zawartym w pliku READ_ME wskażesz im w jaki sposób mogą rozwijać Twój kod.

Zrób dokumentację projektu dla siebie

Z drugiej strony spisanie tego jak działa stworzona przez Ciebie biblioteka, pozwoli na uporządkowanie wiedzy na temat własnego projektu. Usystematyzowanie informacji o własnej pracy może pomóc w dalszym rozwoju projektu, czy ewentualnych poprawkach, do niedociągnięć których wcześniej nie wychwyciliśmy. Ponadto informacje zawarte w pliku READ_ME są świetnym źródłem do przypomnienia sobie szczegółów dotyczących poszczególnych rozwiązań, czy algorytmów w konkretnych części kodu. W wypadku, gdy pracujemy równolegle nad kilkoma projektami i wracamy do porzuconego projektu po pewnym czasie lub kod stał się na tyle rozległy, że nie jesteśmy w stanie zapamiętać wszystkiego dokument opisowy jest niezbędny. Pisanie dokumentacji jest nieodłącznym elementem programowania, którego tak samo jak kodowania musimy się uczyć. Tworzenie kolejnych dokumentacji projektów sprawi, że proces ten będzie dla nas coraz łatwiejszy, a co za tym idzie podniesiemy swoje kwalifikacje zawodowe.

Najnowsze oferty pracy:

Polecane wpisy na blogu IT:

Szukasz pracownika IT?

Dostarczymy Ci najlepszych specjalistów z branży IT. Wyślij zapytanie

Wyrażam zgodę TeamQuest Sp. z o.o. na przetwarzanie moich danych osobowych w celu marketingu produktów i usług własnych TeamQuest, w tym na kontaktowanie się ze mną w formie połączenia telefonicznego lub środkami elektronicznymi.
Administratorem podanych przez Ciebie danych osobowych jest TeamQuest Sp. z o.o., z siedzibą w Warszawie (00-814), ul. Miedziana 3a/21, zwana dalej „Administratorem".
Jeśli masz jakiekolwiek pytania odnośnie przetwarzania przez nas Twoich danych, skontaktuj się z naszym Inspektorem Ochrony Danych (IOD). Do Twojej dyspozycji jest pod adresem e-mail: office@teamquest.pl.
W jakim celu i na jakiej podstawie będziemy wykorzystywać Twoje dane? Dowiedz się więcej