Będę od dziś próbował do moich projektów dodawać sobie plik NEXT_STEPS.md ;-) w którym będę próbował zapisać co ostatnio zrobiłem i dlaczego, oraz co chcę zrobić w przyszłości.
Na razie zaczynam, więc to są luźne myśli. Ale zawsze mi brakowało takiego miejsca i próbowałem w różnych Obsidianach i innych... tym razem spróbuję w kodzie ;-)
Bo gdy dzień się kończy, człowiek kończy zmiany w kodzie to ma w głowie jakieś pomysły, a jak wraca do kodu to te pomysły mogą już być dawno zapomniane.... jak to jest kod pracowy to się zwykle doń wraca dość szybko, więc taki dokument nie jest potrzebny, bo się zwykle pamięta, ale w prywatnych projektach to może być przydatne.
Dla firmowych przydatny mógłby być dokument, który tłumaczy czemu coś zrobiono tak, a nie inaczej. Nie chodzi mi o ADRy, które próbują udawać obiektywność, a o coś co dokumentowałoby "tak, trzymamy wygenerowane credentiale w postaci niezaszyfrowanej, to może być problem, na razie trzymamy je w bazie pod kluczem "UGLY_HACK", w przyszłości jeśli do tego wrócimy bo np. okaże się, że to łamie zasady bezpieczeństwa, to idea jest taka by pod tym samym kluczem (bez UGLY_HACK) trzymać obiekt w którym będą zaszyfrowane credentiale i id klucza użytego do szyfrowwania, WAŻNE klucz powinien być trzymany w AWS Secret Managerze i pobierany leniwie, id klucza może być z kropką do oddzielenia głównego klucza z wersją" i jak ktoś znajdzie w kodzie to co go niepokoi to mógłby przeczytać czemu i od razu wiedziałby jaki był zamysł.
Zobaczę czy będę to stosował, na razie dodałem do 1.5 projektu ;-)
Podobne postybeta
Strasząca książka - Extinction: The Thriller
Generowanie plików ePub z OpenOffice.org :-)
Mam milion rzeczy na głowie... co robić?
Żenienie Todoist z Obsidian przy pomocy Pythona ;-)
Nie lenistwo, a strach. Prawdziwe źródło długu technicznego
Brak komentarzy:
Prześlij komentarz