Заметки: detail или FAQ

[young]

Заметки: detail или FAQ

очень часто встречаются именно заметки
И часто мне их присылают, вида
1) с чем едят magic_quotes_gpc
2) как настроить русский текст в JPGraph

Я считаю что на статьи они ну никак не тянут. Посему

1) сделать на деталях статьи для начинающих?
2) сделать на деталях раздел "заметки"
3) писать их в FAQ

я за 2 или 3

ваши мнения?

 

[HEm]

Может форум завести или раздел на сайте tips&tricks ?
upd+ &solutions

 

[Romantik]

3
+ удобную ссылку в деталях на FAQ

 

[Сергей123]

Мне наиболее близок п.2, т.е. что-то (отдельный раздел detail'а, форума или что-то ещё), где будут заметки (советы, приёмы) малого объёма посвящённые какой-то одной особенности.
Пример - MySQL Tips & Hints из MySQL Newsletter, только с тематической структурированностью.

 

[Фанат]

1) сделать на деталях статьи для начинающих?

стоп.
о чем вообще идет речь? Давайте формализуем.
чуть выше ты пишешь, что на статьи они не тянут и тут же - статьи? По какому признаку не тянут? По объему? Типа, начинающему трудно прочесть большой?
потому, что написаны начинающими?

2) сделать на деталях раздел "заметки"

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

3) писать их в FAQ

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

-~{}~ 11.03.04 11:51:

Я, кстати, хотел одно время предложить переложить фак по сессиям на детали, поскольку по формату оно больше, как мне кажется, подходит. Но остановило именно омертвение, затруднение редактирования. Часто жизнь заставляет вносить коррективы в текст, а на чужом ресурсе как редактировать?

 

[young]

Лучше форум.

в форуме лучше обсуждать
а публиковать лучше на деталях или в FAQ

 

[Фанат]

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

 

[Сергей123]

По п.3 замечу ещё, пожалуй, что лично я полностью согласен с неоднократно высказывавшимся мнением Фаната относительно того, что должно быть в FAQе.

 

[HEm]

Фанат
Речь же идет, насколько я понял о мини-статьях, размером < 2000 символов, такой текст дочитать несложно

 

[young]

, что должно быть в FAQе.

А можно повторить специально для меня: что должно быть в FAQ и чего там быть не должно?

 

[Сергей123]

>> А можно повторить ... ?

Я лучше сформулирую своими словами собственное видение (насколько я помню прошлые обсуждения - оно такое же, как у Фаната).

По-моему, в FAQе должны быть ответы (не обязательно "короткие") на действительно частые вопросы; на вопросы, с которыми сталкивается (или не сталкивается, но лишь по незнанию и в ущерб своим скриптам) большинство PHP-разработчиков.

По-моему, FAQ (по возможности, конечно) должен быть таким, чтобы можно было без зазрения совести рекомендовать прочитать его новичкам полностью, зная, что практически всё в этом FAQе ему обязательно понадобится.

Из "заметок", о которых говорит young, в FAQ, как мне кажется, должны попадать лишь подходящие под такое определение (если таковые окажутся).

 

[young]

действительно частые вопросы;

а куда должны попадать ответы на редкие вопросы?

 

[HEm]

Подытожим?
есть статьи - полностью описывающие какую-то тему - организация такой информации удобна в виде дерева/каталога
есть FAQ - в понятной и доступной форме описывающий решение проблем, на которых спотыкаются 80-90% новичков - организация информации - список из 5-20 часто задаваемых вопросов со ссылками на объяснения
есть заметки (мне больше нравится термин tips&tricks но на русском количество букв в этих терминах в два раза больше) - короткие статьи, описывающие решения не столь распространенных но для кого-то весьма болезненных проблем (то же "как сделать русский шрифт в GD") - таких статеек может набраться огромное число и тут для организации информации важен хороший поиск - вот, собственно, почему я и предложил не прикручивать заметки к деталям а выделить их в отдельный проект.

 

[young]

Ок.
Тогда на первых порах на деталях будет сделан отдельный раздел - заметки, он же "практические советы", он же "how to"
где будет мало теории, много пошаговых инструкций и практических советов.

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

 

[Сергей123]

Автор оригинала: young
а куда должны попадать ответы на редкие вопросы?

По-моему - в предложенный тобою п.2. Как и где он будет организован - надо решать (если, конечно, п.2 победит). Лично я - за отдельный хорошо структурированный раздел на деталях.

 

[young]

отдельный хорошо структурированный раздел на деталях

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

 

[HEm]

Автор оригинала: young
сначала должен появиться материал.

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

 

[Alexandre]

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

 

[Фанат]

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

 

[nw]

Тогда на первых порах на деталях будет сделан отдельный раздел - заметки

Imho это самое лучшее решение, так как "how to" (или Tips&Tricks) это совсем не faq и по своей идее ближе к статьям, чем к ЧАСТО задаваемым вопросам. Другой вопрос, если это дело в клубе уже где-то реализовано...