Wskazówki na temat dobrego stylu
Tu jest kilka wskazówek pomocnych przy pisaniu dobrej strony wiki. Można swobodnie dodawać dalsze wskazówki lub komentarze na końcu strony.
Struktura strony
Zacznij swoją stronę od tytułu pierwszego poziomu, który dobrze oddaje jej zawartość.
Podziel tekst na akapity pozostawiając między nimi pusty wiersz. Przeciętny akapit nie powinien być dłuższy niż 10-20 wierszy.
Jeżeli twój tekst jest dłuższy niż kilka (3-5) akapitów, rozważ podzielenie go na kilka
rozdziałów dodając tytuły poziomu 2 do 5.
Gdy twój tekst staje się dłuższy niż 2-3 strony ekranu, dodaj jej krótkie streszczenie po głównym tytule.
Jeżeli masz dużo linków do innych stron wiki lub do zasobów zewnętrznych, dodaj osobny rozdział dla nich (zobacz
niżej).
Wyróżniaj pojedyncze słowa lub krótkie fragmenty tekstu używając pogrubienia lub pochylenia. Wybierz jedno z nich i trzymaj się swojego wyboru.
Wybierz styl dla przedstawiania kopii ekranów, tekstu na ekranach jak przyciski czy podpisy i używaj ich konsekwentnie. Dobrym pomysłem jest utworzenie strony wyjaśniającej konwencję stylu w twoim wiki.
Stosuj
wypunktowania dla niezależnych od siebie stwierdzeń. Jeżeli rozwijasz ciąg myślowy, pisz ciągą sekwencją zdań.
Przypisy stosuj oszczędnie i tylko do bardzo krótkich dodatkowych uwag. Jeżeli jest dużo więcej do powiedzenia na dany temat, wpisz to na nowej stronie. Jeżeli chcesz odnieść się do innych (zewnętrznych) źródeł informacji, zrób to za pomocą
linków.
Tabele mogą znacznie poprawić czytelność ustrukturyzowanych danych. Gdy wstawiasz tabelę, upewnij się że ma zrozumiałe nagłówki kolumn i posiada podpis który jasno określa zawartość tej tabeli (np. „Tabela 1.2: Średnia odległość między planetami”).
Język
Pisz zdania stosując zasady gramatyki.
Zaczynaj każde zdanie z wielkiej litery i zakończ kropką lub innym odpowiednim znakiem interpunkcyjnym.
Staraj się pisać krótkie, jasne zdania bez zbytecznego stosowania zdań podrzędnych. Gdy uważasz iż skończyłeś stronę, przeczytaj ją jeszcze raz i skoryguj każde zdanie, które ma zbyt skomplikowaną strukturę.
Zdecyduj jak będziesz zwracać się do czytelników. Jeżeli DokuWiki jest nastawione na tworzenie dokumentacji, będziesz musiał często instruować swoich czytelników, jak zrobić określone rzeczy. Możesz stosować tryb rozkazujący („wykonaj”, „zaznacz”), formę bezokolicznikową („należy wykonać”, „trzeba zaznaczyć”) lub pisać w pierwszej osobie („wykonuję”, „zaznaczam”). Nie mieszaj form.
Sprawdź swoją stronę pod kontem błędów ortograficznych przed jej zapisaniem. Jeżeli w twoim tekście będzie dużo błędów, to zmiejszy to wiarygodność twoich wypowiedzi, bez względu na to jak dobrze zostały przemyślane.
Rozwiń swój własny styl. Nie zmuszaj się do pisania w sposób, który nie jest dla ciebie wygodny. To brzmiałoby nienaturalnie i nie byłoby przyjemną lekturą.
Odnośniki
Gdy wprowadzasz pojęcie, które wymaga więcej wyjaśnień,
dodaj nową stronę wiki dla tego pojęcia i wstaw link do niego.
Sprawdź ponownie całą stronę zanim ją zapiszesz.
Dodaj linki w istniejących stronach do głównych pojęć użytych w twojej stronie
Nie dodawaj linków przy każdym wystąpieniu pojęcia. Oznacz linkiem pierwsze lub najważniejsze wystąpienie na stronie, możesz też dodać link w przypisach.
Umieść na stronie linki do źródeł grafik, danych i cytatów.
Rozważ dodanie sekcji „Zobacz także:” na końcu swojej strony. Podaj linki do stron wiki, które są blisko powiązane z tematem twojej strony.
Jeżeli chcesz wskazać zewnętrzne źródła, które podają więcej informacji na twój temat lub które były użyte podczas pisania twojej strony, dodaj sekcję „Bibliografia” lub „Więcej informacji” na końcu i listę linków lub innych odwołań (np. numerów ISBN). Jeżeli nie zrobiłeś już tego w głównym tekście, opisz zawartość źródła (np. na [tej stronie] znajdziesz więcej informacji na temat rozkładu normalnego).
Zdjęcia i inne pliki
„Jeden obraz wart więcej niż tysiąc słów.” Może nawet nieść więcej treści, niż planowałeś przekazać. Ludzie mają mniejszą skłonność do poddawania w wątpliwość obrazów niż tekstu. Jednak krótki opis tekstowy jest czasami lepszy niż nic lub niż nieodpowiedni obraz.
Tak jak w przypadku tabel, zawsze umieść podpis mówiący co chcesz przekazać przez umieszczoną grafikę.
Jeżeli nie stworzyłeś grafiki samodzielnie, to podaj źródło (najlepiej linkiem) i prawa autorskie.
Nie linkuj zewnętrznej grafiki, gdyż powoduje to zbędne obciążenie zdalnego serwera. Jeżeli tylko możesz, to wklej grafikę do wiki.
Jeżeli zdjęcie jest większe niż mniej więcej jedna trzecia ekranu, to zastosuj
link ze zmianą wielkości by wstawić miniaturę.
Dodatki
Komentarze