This week I'm continuing the documentation topic. I'm giving insight on how we're using Algolia in Event Store for advanced search in our docs. I explained the whole flow with samples scraping the data and automating it with Github Actions.
Jeden z najnudniejszych, najmniej seksownych, najczęściej odsuwanych w czasie tematów w projektach? Dokumentacja! W tym odcinku rozmawiamy właśnie o niej…
Architektura 1716 dni, 10 godzin, 1 minutę temu 68 źrodło rozwiń
Od jakiegoś czasu sporo programuję, wykorzystując Visual Studio Code. Podczas tworzenia kodu przydaje się również dokumentacja. Ostatnio odkryłam funkcję podglądu plików .md, a także wtyczkę, która umożliwia sprawdzanie składni takich plików.
Tworząc projekt open source w pewnym momencie przychodzi czas, w którym należałoby nasze dzieło udokumentować celem jego zrozumienia przez innych programsitów. Dostawcy usług jak GitHub czy Bitbucket oferują wbudowane mechnizmy jak popularne Wiki, jednak według mnie posiadają one kilka zasadniczych minusów:Wiki jest nierozłączną częscią repozytorium projektu (choć można zrobić niezależny clone).Wiki nie jest (jawnie) wersjonowane. Wgląd w kolejne rewizje jest możliwy, ale nie mamy mozliwości np. utworzen...
Masz jakieś API chciałbyś sprawdzić listę swoich endpointów? Swagger to najlepsze narzędzie do tego – do tworzenia interaktywnej dokumentacji API.
Programiści z dokumentacją mają taki problem, że nie lubimy jej czytać i nie lubimy jej pisać. Niestety często wiąże się to z ciekawymi WTFami gdy kod zachowuje się nie tak jakbyśmy tego od niego oczekiwali.
Sztuka programowania 2598 dni, 13 godzin, 19 minut temu 142 źrodło rozwiń
Dokumentacja kodu w końcu ma ręce i nogi :)
Daj się poznać 2017 2796 dni, 6 godzin temu 23 źrodło rozwiń
Writing a project documentation – everyone’s or at least the programmer’s nightmare, right? Although at a first glance many of you will most likely agree with the given assumption, I’ll try to convince you otherwise. Not only it doesn’t have to be a dull experience, but it might be a truly fun and quite refreshing activity, which shall provide the great value for the project.
Description of my journey in search of good documentation. Main documentation principles with examples
Sztuka programowania 3019 dni, 10 godzin, 30 minut temu 60 źrodło rozwiń
C# ma tę genialną zaletę, że pozwala komentować swoją treść specjalnymi znacznikami XML. Natychmiastowym efektem takich komentarzy jest ich prezentacja w postaci pomocy kontekstowej dla elementów kodu, które zostały nimi opatrzone. Drugie ich zastosowanie, to możliwość wygenerowania dla każdego pliku z treścią oprogramowania dokumentacji zawierającej elementy opatrzone wspomnianym typem komentarza. Niestety – określanie tych plików mianem dokumentacji jest nadużyciem...
Nie dawno otrzymałem email z pytaniem dotyczącym tworzenia dokumentacji do kodu napisanego w C#: Poszukuje czegoś do zautomatyzowania procesu tworzenia dokumentacji dla kodu pisanego w C# i trafiłem na (..) temat odnośnie Sandcastle. Czy ten dodatek do Visual Studio pozwala tworzyć dokumentacje dla C# i jest kompatybilny z VS 2010? Spróbuję w niniejszym wpisie odpowiedzieć na to pytanie. Na temat tworzenie dokumentacji do oprogramowania pisałem już wcześniej w artykule „Tworzenie dokumentacji”. Wspomni...