dotnetomaniak.pl - Artykuły z tagiem dokumentacja

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.

Źródło: event-driven.io
Dziel się z innymi:
How to enhance and configure your site search with Algolia? - Oskar Dudycz

Narzędzia 1322 dni, 10 godzin, 21 minut temu oskar-at-net 42 źrodło rozwiń

Jeden z najnudniejszych, najmniej seksownych, najczęściej odsuwanych w czasie tematów w projektach? Dokumentacja! W tym odcinku rozmawiamy właśnie o niej…

Tagi: adr, dokumentacja
Źródło: patoarchitekci.io
Dziel się z innymi:
Dokumentacja...

Architektura 1716 dni, 10 godzin, 1 minutę temu Łukasz Kałużny 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.

Dziel się z innymi:
Pliki MD w VS Code – programmer-girl

Narzędzia 2052 dni, 10 godzin, 48 minut temu Weronika Mularczyk 80 źrodło rozwiń

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...

Źródło: foreverframe.net
Dziel się z innymi:
Tworzenie dokumentacji projektowej z Read the Docs - Forever F[r]ame

Narzędzia 2224 dni, 8 godzin, 39 minut temu dpawlukiewicz 115 źrodło rozwiń

Masz jakieś API chciałbyś sprawdzić listę swoich endpointów? Swagger to najlepsze narzędzie do tego – do tworzenia interaktywnej dokumentacji API.

Dziel się z innymi:
Swagger – interaktywna dokumentacja API – programmer-girl

Narzędzia 2399 dni, 8 godzin, 37 minut temu Weronika Mularczyk 160 źrodło rozwiń

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.

Źródło: blog.octal.pl
Dziel się z innymi:
RTFD - Read The F* Documentation - .net blog - octal.pl | Paweł Łukasik

Sztuka programowania 2598 dni, 13 godzin, 19 minut temu Paweł Łukasik 142 źrodło rozwiń

Dokumentacja kodu w końcu ma ręce i nogi :)

Źródło: blog.gutek.pl
Dziel się z innymi:
Elixir #30 - Testy za pomocą dokumentacji - Jakub Gutkowski

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.

Dziel się z innymi:
Documentation as a project booster | Piotr Gankiewicz

Inne 2911 dni, 9 godzin, 16 minut temu spetz 76 źrodło rozwiń

Description of my journey in search of good documentation. Main documentation principles with examples

Źródło: www.diwebsity.com
Dziel się z innymi:
[EN] Expedition in search of good documentation - Diwebsity

Sztuka programowania 3019 dni, 10 godzin, 30 minut temu suvroc 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...

Źródło: paskol.robi.to
Dziel się z innymi:
Me z .NET tete-a-tete » Jak nie popaść we frustrację, gdy chcesz mieć dokumentację

Narzędzia 4462 dni, 20 godzin, 10 minut temu PaSkol 161 źrodło rozwiń

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...

Dziel się z innymi:
Tworzenie dokumentacji do kodu w C# [PL] | Maciej Zbrzezny: Programowanie i Technologie

Narzędzia 4732 dni, 19 godzin, 35 minut temu Paweł Łukasik 630 źrodło rozwiń

Najaktywniejsi w tym miesiącu