Dlaczego warto tworzyć pliki READ_ME.MD?12 stycznia 2018

Dlaczego warto tworzyć pliki READ_ME.MD?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.

Twoja opinia jest dla Nas Ważna

Oceń ten wpis
Prześlij nam swoje CV

Najnowsze oferty pracy:

Polecane wpisy na blogu:

Ramię w ramię z firmą rekrutacyjną. 4 kroki do udanej współpracy

Senior Developer czyli kto?

Osiem myśli, o których myślisz pierwszego dnia w pracy

Najnowsze komentarze

jasiek
2018-04-24 16:03:41
Magdalena Mbn
2018-04-23 11:01:45
Magdalena Mbn
2018-04-23 10:53:42
LukeSEOker
2018-04-10 11:03:08
PiotrG
2018-03-13 06:26:01
Lukasz Usarz
2018-03-12 13:59:54
Amanda Sadkowicz
2018-02-16 08:14:52
Adam
2018-02-14 14:52:49
Martyna Ciempek
2018-02-01 23:48:04
Kasia Nowak
2018-01-16 15:43:48
Może zainteresuje Cię również: