Cel:
Celem FAQ i Propozycji nie jest kopiowanie gotowych dokumentow a tworzenie porad z rozwiazan wyniklych w trakcie dyskusji na forum, jak rowniez publikacja poradnikow napisanych przez uzytkownikow specjalnie do FAQ.
Podstawowe reguly:
a. każdy osobny wątek to omówienie osobnego problemu wraz z jego rozwiązaniem
b. każdy nowy temat musi być najpierw opublikowany w dziale PROPOZYCJE FAQ
c. można komentować dokumenty już opublikowane w FAQ poprzez tworzenie wątku z uwagami w PROPOZYCJACH FAQ o temacie zbliżonym, odwołującym się do oryginału
d. tylko administratorzy i moderatorzy moga przeniesc dokument do FAQ
-----
2005-03-11 / 20:10 - Skyscraper - reedycja tekstu
[Regulamin] - Zasady tworzenia F.A.Q
Moderatorzy: Moderatorzy, Administratorzy
[Regulamin] - Zasady tworzenia F.A.Q
Ostatnio zmieniony 2006-10-20, 11:55 przez Corvin, łącznie zmieniany 2 razy.
"Spróbuj zapalić maleńką świeczkę zamiast przeklinać ciemność."
Konfucjusz
Konfucjusz
- Skyscraper
- Administrator
- Posty: 753
- Rejestracja: 2004-05-22, 10:46
- Lokalizacja: Wrocław
- Kontakt:
Re: [Regulamin] - Zasady tworzenia F.A.Q
Konwencje przy pisaniu dokumentu FAQ (przykladowe, zalecane)
1. dokument powinien miec tytul pogrubiony
2. dokument powinien miec stopke zawierajaca informacje o autorze i ewentualne uwagi
3. dokument powinien posiadac strukture rozdzialową
4. rozdzialy oznaczamy w hierarchii: 1... a... -... (cyfra, litera, myslnik)
5. nazwy specyficzne lub jesli cos akcentujemy, pogrubiamy
6. sciezki dostepu, nazwy plikow, komendy piszemy kursywą (np.: /var/log/samba)
7. przed komendami stawiamy znak hash # lub dolar $ (np.: # ls -l)
8. nazwy plikow staramy sie podawac z pelna sciezka np.: /etc/lilo.conf
9. zawartosc plikow, tresc skryptow, wyniki polecen z ekranu ujmujemy w znaczniki code np.:
10. staramy sie pisac w miare oficjalnie, bez slangu i dziwnym skrotow/tesktow w koncu to ma być dokumentacja
11. tresc powinna byc latwa do zrozumienia
12. piszemy tekst tak jak bysmy chcieli aby nam tekst napisano
1. dokument powinien miec tytul pogrubiony
2. dokument powinien miec stopke zawierajaca informacje o autorze i ewentualne uwagi
3. dokument powinien posiadac strukture rozdzialową
4. rozdzialy oznaczamy w hierarchii: 1... a... -... (cyfra, litera, myslnik)
5. nazwy specyficzne lub jesli cos akcentujemy, pogrubiamy
6. sciezki dostepu, nazwy plikow, komendy piszemy kursywą (np.: /var/log/samba)
7. przed komendami stawiamy znak hash # lub dolar $ (np.: # ls -l)
8. nazwy plikow staramy sie podawac z pelna sciezka np.: /etc/lilo.conf
9. zawartosc plikow, tresc skryptow, wyniki polecen z ekranu ujmujemy w znaczniki code np.:
Kod: Zaznacz cały
echo "Uruchamianie demonów Samby - smbd, nmbd..."
/usr/sbin/smbd -D
/usr/sbin/nmbd -D
11. tresc powinna byc latwa do zrozumienia
12. piszemy tekst tak jak bysmy chcieli aby nam tekst napisano
Ostatnio zmieniony 2006-08-01, 15:48 przez Skyscraper, łącznie zmieniany 1 raz.