From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: To: ALT Devel discussion list Subject: Re: [devel] =?koi8-r?b?0M/MydPJIMTM0SDP0MnTwc7JyiDQwcvF1M/XOiDa?= =?koi8-r?b?wSDJINDSz9TJ1w==?= References: <20040406121821.GE2531@susanin.localdomain> X-Request-PGP: x-hkp://wwwkeys.nl.pgp.net X-PGP-KeyID: 4A101D3B From: Maxim Tyurin Date: Tue, 06 Apr 2004 15:20:24 +0300 In-Reply-To: <20040406121821.GE2531@susanin.localdomain> (Kirill Maslinsky's message of "Tue, 6 Apr 2004 16:18:21 +0400") Message-ID: User-Agent: Gnus/5.110001 (No Gnus v0.1) Emacs/21.3 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=koi8-r Content-Transfer-Encoding: 8bit X-BeenThere: devel@altlinux.ru X-Mailman-Version: 2.1.4 Precedence: list Reply-To: ALT Devel discussion list List-Id: ALT Devel discussion list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 06 Apr 2004 12:22:05 -0000 Archived-At: List-Archive: List-Post: Kirill Maslinsky writes: > Добрый день! > > Составляя справочный раздел документации на основе описаний пакетов, я > обнаружил ужасный разнобой в терминологии, информативности и оформлении, > а также огромное количество банальных опечаток, не говоря уже о размашистости > стиля и жаргонности отдельных описаний. Словарь терминов давно пора составить. Для оЧЕпяток есть ispell :) А стиль он у каждого свой и ИМХО исправлениям совсем плохо поддается. > > Отчетливо видно отсутствие какого-либо регулирующего полиси относительно > словесных описаний, которыми сопровождаются пакеты. > > Причем описание пакета -- это первая и весьма существенная документация, > на основании которой удобно было бы судить о необходимости установки > этого пакета на свою машину и т. п. > > На мой взгляд, стоило бы следить за такими вещами: > - орфография/пунктуация > - единообразие терминов ("среда KDE"/"окружение KDE"; > "UTF-8"/"utf8" etc.) И обязательно с кодировками описаний беспредел исправить, а то apt-cache приходится пару раз через iconv прогонять > - информативность: > если в пакете собрано несколько утилит: перечислять их с > кратким пояснением, если пакет предоставляет часть > какой-то более общей функциональности или сопровождается > отдельным пакетом с документацией/плагинами -- упоминать > их в описании. (Пока больше точных требований > сформулировать не могу, однако чем информативнее, тем > лучше.) > - стиль/удобопонятность: > изгонятьс сугубо жаргонные выражения, и стараться писать > так, чтобы из описания совершенно не знакомый с > областью человек мог понять, для чего нужен данный пакет > и нужен ли он ему. > > Возможно, некоторые из этих задач можно автоматизировать? > (хотя бы ispell) > > Возможно, стоит отдавать все описания на просмотр централизованному > редактору (перед принятеим в репозиторий)? Нудная это работа. Сомневаюсь что кто-то этим заняться захочет. > Ваши соображения? Давно пора :) -- With Best Regards, Maxim Tyurin JID: MrKooll@jabber.pibhe.com