Препоръки към авторите

FIXME: Тази секция може би се нуждае от обсъждане.

Всеки, който добавя някакъв код, би трябвало да:

Книгата е голяма, затова не може да се очаква всички да я прочетат от началото до края, като при това да запомнят всяко нещо къде е. Поради тази причина трябва да се отделя специално внимание къде точно поставяте своите материали и какво заглавие им слагате. Ръководното правило е да се поставяте на мястото на читателя. Поставете се на негово място, погледнете дългото съдържание и решете къде бихте търсили Вашия материал.

Следващото нещо е заглавието на материала. Съобразете се с мястото, което сте избрали. Не претоварвайте заглавието, но и не го правете неясно. Ако материалът може да се опише с една ключова дума, сложете я като първа в заглавието (в \textit) и я отделете с двоеточие. Идеалният вариант е тази ключова дума да е име на пакет, име на команда или име на файл.

Използвайки този начин, позволявате на по-напредналите потребители по-бързо да намират информацията, която им е нужна, защото тези ключови думи може да им говорят повече от самото заглавие. Начинаещите потребители също печелят, защото самото съдържание на книгата става като справочник за пакети, команди и файлове. Ето пример за секция:

\chapter{\textit{stow}: Инсталиране на не-дебиански софтуер}

Избягвайте да пишете команди, вградени в самите абзаци на текста. Отделяйте ги в \begin{verbatim}. По този начин човек, без да чете текста, добива представа какво трябва да се прави. В крайна сметка в командите, които препоръчвате, се съдържа цялата практична страна на Вашия материал.

Поради същата причина не вграждайте примерни редове от файлове в текста, а използвайте \begin{verbatim}.

Добре е първото изречение на абзац да въвежда в темата на абзаца. Така се дава по-добра възможност да се пресява нужното за читателя от ненужното.

Използвайте богатството на LATEX.



George Danchev 2004-12-25