Poradnik użytkownika

Masz pomysł na funkcjonalność lub koncepcję na rozwój projektu. Opisz wszystko tutaj.
User avatar
klimasstudio
Posts: 1273
Joined: Wed Aug 28, 2019 9:35 pm
Location: localhost

Post

Myślę że taki spis z podziałem na rozdziały i ogólny szkielet opisu byłby super rozwiązaniem.
Więc chodź OSUPLUJE Ci dom :mrgreen:

Druk 3D - > https://klimastech.eu.org/druk-3d
User avatar
myxhir
Posts: 664
Joined: Thu Jan 07, 2021 12:16 pm
Location: Skórzewo, Poznań
Has thanked: 6 times
Been thanked: 9 times

Post

Widzę że propozycja została miło przyjęta:-)
klimasstudio wrote: Thu Aug 03, 2023 7:09 am Myślę że taki spis z podziałem na rozdziały i ogólny szkielet opisu byłby super rozwiązaniem.
Wstępny szkic właśnie jest w tym co zaprezentowałem ale jest to moja propozycja a wiadomo ile ludzi tyle wersji :-)

Co do nadzoru wersji dokumentacji nie myślałem o tym i nie wypowiem się. Rozumiem że jeśli pisze się taka dokumentację w powiązaniu z githubem bo nie pisze się tego w klasyczny sposób jak w Wordzie ale raczej jak tekst obwsrowany jakimiś częściami kodu które definiują styl punktory itp?
To co zamieściłem w spisie jestem w stanie napisać ale jak wspomniałem na początku nie mam wszystkich urządzeń. W planie miałem też dodać tam rozdział do ciekawych projektów na zasadzie krótkiego opisu i link do forum żeby zainteresowany tam sobie znalazł szczegóły i pomoc.
Spełniony Automatyk / Mąż / Świeżo Upieczony Ojciec
[email protected]
Posts: 1586
Joined: Mon Feb 06, 2023 8:56 am
Has thanked: 18 times
Been thanked: 26 times

Post

myxhir wrote: Thu Aug 03, 2023 7:51 am Widzę że propozycja została miło przyjęta:-)
klimasstudio wrote: Thu Aug 03, 2023 7:09 am Myślę że taki spis z podziałem na rozdziały i ogólny szkielet opisu byłby super rozwiązaniem.
Wstępny szkic właśnie jest w tym co zaprezentowałem ale jest to moja propozycja a wiadomo ile ludzi tyle wersji :-)

Co do nadzoru wersji dokumentacji nie myślałem o tym i nie wypowiem się. Rozumiem że jeśli pisze się taka dokumentację w powiązaniu z githubem bo nie pisze się tego w klasyczny sposób jak w Wordzie ale raczej jak tekst obwsrowany jakimiś częściami kodu które definiują styl punktory itp?
To co zamieściłem w spisie jestem w stanie napisać ale jak wspomniałem na początku nie mam wszystkich urządzeń. W planie miałem też dodać tam rozdział do ciekawych projektów na zasadzie krótkiego opisu i link do forum żeby zainteresowany tam sobie znalazł szczegóły i pomoc.
Visual Studio Code ma fajna wtyczkę do Markdowna, która sugeruje błędy i pozwala na wizualizację tekstu, a sam Markdown jest mega prosty, w przeciwieństwie do HTMLa to opiera się na wcięciach i kilkunastu znacznikach, więc nie powinno być problemu.

Co do wersjonowania Github wydaje się najlepszym pomysłem, bo każdy może zgłosić PullRequest i wszyscy widzą co inni zgłaszają + pokazuje pogląd Markdowna.

Read the Docs używa Sphinxa, który łagodnie mówiąc nie jest przyjazny użytkownikowi i czasem ciężko uzyskać prosty efekt w stylu tabelki gdzie jest dużo tekstu, trzeba formatować CSSami itd. - używałem w jednym projekcie i nie polecam...
User avatar
myxhir
Posts: 664
Joined: Thu Jan 07, 2021 12:16 pm
Location: Skórzewo, Poznań
Has thanked: 6 times
Been thanked: 9 times

Post

na razie chyba odpuszczę inne aplikacje niż Word, jest dla mnie szybszy. Jak napiszę całość którą zakładałem to wówczas można to potem przenieść na coś innego. Prace idą powoli ale systematycznie gdyż pisanie w konwencji jaką sobie założyłem trochę czasu zabiera a robię to w wolnej chwili ;) zaktualizowałem plik w pierwszym poście. być może finalnie przeniosę to na dysk Google.
Spełniony Automatyk / Mąż / Świeżo Upieczony Ojciec
User avatar
YoMan
Posts: 3522
Joined: Thu Apr 30, 2020 5:18 pm
Location: Częstochowa
Has thanked: 3 times
Been thanked: 3 times

Post

Przydałby się jakiś "przewodnik", żeby np. dwie osoby nie pisały o tym samym i zachować spójność. Coś jak prowadzenie projektu na GitHubie.
Ja mogłbym coś popelnic ale nie jestem w stanie teraz sie zobowiazac co do czasu. A moze się znikąd pojawic czas i wena wtedy moge kliknąc, zerknąć jaki temat jest wolny i coś skrobnąc.
YoMan
________________________________________
Wziąłem udział w SOP2023 & SOP2024
User avatar
uchnast.michal
Posts: 1334
Joined: Tue Jun 04, 2019 11:37 am
Has thanked: 7 times

Post

YoMan wrote: Tue Aug 08, 2023 10:55 am
Już o tym wspominałem lecz pytanie kto szkielet mógłby przygotować, niewątpliwie ktoś o dużej wiedzy ogólnej. Pozostaje również otwarta kwestia narzędzia.
krycha88
Posts: 5575
Joined: Fri Nov 16, 2018 7:25 am
Been thanked: 5 times

Post

już jakiś czas zaczęliśmy pisać poradnik dla GUI https://gui-generic-builder.supla.io/guide/ ale nie jest to takie proste jakby się wydawało :)
https://gui-generic-builder.supla.io/
User avatar
myxhir
Posts: 664
Joined: Thu Jan 07, 2021 12:16 pm
Location: Skórzewo, Poznań
Has thanked: 6 times
Been thanked: 9 times

Post

krycha88 wrote: Tue Aug 08, 2023 11:45 am już jakiś czas zaczęliśmy pisać poradnik dla GUI https://gui-generic-builder.supla.io/guide/ ale nie jest to takie proste jakby się wydawało :)
zgadzam się że nie jest proste, ostatnio mam mniej czasu na takie pisanie ale jak już się podjąłem to dokończę pracę a potem jak wspomniałem wcześniej wrzucę to na dysk google razem z plikiem edycyjnym i niech społeczność zadecyduje co z tym zrobi czy to będzie wykorzystane i przeniesione na GITa - mi osobiście brakuje wiedzy o tym jak tym w pełni zarządzać. Na pewno jak bym załapał podstawy to się okazałoby to dziecinnie banalne ale nie chce poświęcać na to zasobów ;) Do poradnika na 1 stronie dodałem datę także będzie widać z pierwszego postu w jakim dniu był generowany plik.
Spełniony Automatyk / Mąż / Świeżo Upieczony Ojciec

Return to “Pomysły i koncepcje”