ALT Linux Team development discussions
 help / color / mirror / Atom feed
* [devel] полиси для описаний пакетов: за и против
@ 2004-04-06 12:18 Kirill Maslinsky
  2004-04-06 12:20 ` Maxim Tyurin
  2004-04-06 12:20 ` [devel] Re: полиси для описаний пакетов: за и против Michael Shigorin
  0 siblings, 2 replies; 26+ messages in thread
From: Kirill Maslinsky @ 2004-04-06 12:18 UTC (permalink / raw)
  To: ALT Devel discussion list

Добрый день!

Составляя справочный раздел документации на основе описаний пакетов, я
обнаружил ужасный разнобой в терминологии, информативности и оформлении,
а также огромное количество банальных опечаток, не говоря уже о размашистости
стиля и жаргонности отдельных описаний. 

Отчетливо видно отсутствие какого-либо регулирующего полиси относительно
словесных описаний, которыми сопровождаются пакеты.

Причем описание пакета -- это первая и весьма существенная документация, 
на основании которой удобно было бы судить о необходимости установки
этого пакета на свою машину и т. п.

На мой взгляд, стоило бы следить за такими вещами:
	- орфография/пунктуация
	- единообразие терминов ("среда KDE"/"окружение KDE";
	  "UTF-8"/"utf8" etc.)
	- информативность:
		если в пакете собрано несколько утилит: перечислять их с 
		кратким пояснением, если пакет предоставляет часть
		какой-то более общей функциональности или сопровождается 
		отдельным пакетом с документацией/плагинами -- упоминать
		их в описании. (Пока больше точных требований
		сформулировать не могу, однако чем информативнее, тем
		лучше.)
	- стиль/удобопонятность:
		изгонятьс сугубо жаргонные выражения, и стараться писать
		так, чтобы из описания совершенно не знакомый с
		областью человек мог понять, для чего нужен данный пакет
		и нужен ли он ему.
	
Возможно, некоторые из этих задач можно автоматизировать? 
(хотя бы ispell)

Возможно, стоит отдавать все описания на просмотр централизованному
редактору (перед принятеим в репозиторий)?

Ваши соображения?


-- 
Kirill Maslinsky ALT Linux Team *
Documentation Project   


^ permalink raw reply	[flat|nested] 26+ messages in thread

end of thread, other threads:[~2004-04-07 13:04 UTC | newest]

Thread overview: 26+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2004-04-06 12:18 [devel] полиси для описаний пакетов: за и против Kirill Maslinsky
2004-04-06 12:20 ` Maxim Tyurin
2004-04-06 12:39   ` Kirill Maslinsky
2004-04-06 12:42     ` Alexey I. Froloff
2004-04-06 12:56       ` Kirill Maslinsky
2004-04-06 19:16         ` Вячеслав Диконов
2004-04-07  7:05           ` Vital Khilko
2004-04-07  9:48             ` Dmitry V. Levin
2004-04-07  9:53               ` Nick S. Grechukh
2004-04-07  9:55                 ` Dmitry V. Levin
2004-04-07  9:58                   ` Nick S. Grechukh
2004-04-07 10:35                     ` Dmitry V. Levin
2004-04-07  9:57               ` Alexander Bokovoy
2004-04-07 10:15               ` Vital Khilko
2004-04-07 10:34                 ` Dmitry V. Levin
2004-04-07 11:01               ` Dmitry V. Levin
2004-04-07 12:23                 ` Vital Khilko
2004-04-07 12:48                   ` Dmitry V. Levin
2004-04-07 13:04                     ` Vital Khilko
2004-04-06 12:48     ` [devel] " Michael Shigorin
2004-04-06 16:43   ` [devel] " Vitaly Lipatov
2004-04-06 17:18     ` Kirill Maslinsky
2004-04-06 20:20       ` [devel] полиси для описаний пакетов: за и против [JT] Vitaly Lipatov
2004-04-06 12:20 ` [devel] Re: полиси для описаний пакетов: за и против Michael Shigorin
2004-04-06 12:41   ` Kirill Maslinsky
2004-04-06 12:49     ` Aleksey Novodvorsky

ALT Linux Team development discussions

This inbox may be cloned and mirrored by anyone:

	git clone --mirror http://lore.altlinux.org/devel/0 devel/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 devel devel/ http://lore.altlinux.org/devel \
		devel@altlinux.org devel@altlinux.ru devel@lists.altlinux.org devel@lists.altlinux.ru devel@linux.iplabs.ru mandrake-russian@linuxteam.iplabs.ru sisyphus@linuxteam.iplabs.ru
	public-inbox-index devel

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://lore.altlinux.org/org.altlinux.lists.devel


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git