Notatki w dokumentacji bardzo pomagają

Autor: Dondu

Ten artykuł jest odpowiedzią na pytanie jednego z czytelników:

Arkadiusz
Jak ty ogarniasz problem szybkiego odnajdywania fragmentów kodu rozpracowanych wcześniej mikrokontrolerów w szczególności, gdy korzystasz z wielu rodzin, które strasznie się między sobą różnią?

Jedną z bardziej pomocnych możliwości w szczególności na początku drogi przez mękę związaną z czytaniem dokumentacji jest wykonywanie notatek, by ułatwić jej ponowne użycie.

Dokumentacja jest tworzona w 99% w postaci plików w formacie PDF. W tym przypadku przychodzi nam z pomocą Adobe Reader, który posiada możliwości wykonywania notatek, podkreśleń, itp. co szerzej opisałem w tym temacie.

Ja często zapisuję na przykład podstawowe fragmenty programu dot. danego fragmentu datasheet. Na przykład tak:

Fragment dot. przetwornika analogowo-cyfrowego.

Fragment dot. modułu generowania PWM.

Tak rozpracowywana (jak to określił Arkadiusz) dokumentacja jest bardzo cenną kopalnią wiedzy i odciąża naszą głowę przed zbędną ilością informacji zwiększając przy okazji szybkość tworzenia nowych projektów, na bazie używanych wcześniej mikrokontrolerów.

Ma to szczególne znaczenie, gdy mikrokontrolery znacznie się między sobą różnią (nawet w zakresie jednej rodziny) w czym przodują mikrokontrolery Microchip-a, co ja akurat uważam za ich zaletę, a nie wadę :-)