На главную Наши проекты:
Журнал   ·   Discuz!ML   ·   Wiki   ·   DRKB   ·   Помощь проекту
ПРАВИЛА FAQ Помощь Участники Календарь Избранное RSS
msm.ru
! Друзья, соблюдайте, пожалуйста, правила форума и данного раздела:
Данный раздел не предназначен для вопросов и обсуждений, он содержит FAQ-заготовки для разных языков программирования. Любой желающий может разместить здесь свою статью. Вопросы же задавайте в тематических разделах!
• Если ваша статья может быть перенесена в FAQ соответствующего раздела, при условии, что она будет оформлена в соответствии с Требованиями к оформлению статей.
• Чтобы остальным было проще понять, указывайте в описании темы (подзаголовке) название языка в [квадратных скобках]!
Модераторы: Модераторы
  
> Как писать статьи в Фак , Прежде чем писать, загляни сюда ;)
    Пишем статьи в ФАК.
    1. Начнем с заголовка, он должен отражать суть темы, быть "большого размера" и одного цвета (фиолетовый).
    2. Итак, о самом тексте: подзаголовки выделяйте жирным шрифтом, "большого размера", не используйте все цвета радуги. Человеку будет неудобно писать. Если в тексте есть места, на которые нужно обратить особое внимание, выделяйте их жирным шрифтом. Господа программисты, пожалуйста, используйте текст. Голым кодом мало что можно обьяснить!
    3. О коде: используйте комментарии, но только в объясняемом участке, а не во всей программе. Не выкладывайте весь код, только объясняемые участки!
    4. Про аттачи: не пренебрегайте ими, статья с аттачем намного наглядней, вот в аттаче можно выложить весь исходник, но не скомпилированный, так как не у всех быстрый интернет.
    Заключение: В конце статьи советую сделать раздел ключевых слов, для удобств поиска по факу. Если не вы являетесь автором примера, то не забудьте использовать копирайты. Для координаторов и модераторов: если пример согласован, то в конце темы указывайте куда она перенесена


    Жду критики и дополненей в сатью
      1. Не "огромного размера", а большого.
      2. Перед двоеточием и другими знаками препинания пробел не ставится (кроме тире).
      3. А вот после знаков препинания пробел ставится всегда! Исключение - точка в конце абзаца.
      4. Насчет ссылок на другие ресурсы: можно, но совсем не обязательно (а на другие форумы даженежелательно - у нас собственный FAQ, незачем других рекламировать). Даже лучше, если человек придумает что-то оригинальное и выложит это у нас, чем использует другой источник и поместит на него ссылку.
        исправил несколько ошибок по русскому языку и пару стилистических моментов :)
        1. "Большой" размер обязательно нужно стандартизировать. Вот у тебя используется size=14. На мой взгляд было бы достаточно и 12. Что скажут остальные?
        а) Заголовок лучше плюс к этому выделять еще и жирным шрифтом.
        б) Фиолетовый цвет, во-первых, не согласуется с общим дизайном форума, а во вторых, лично для меня неприятен. Не знаю, как микрософт догадался использовать его для посещенных ссылок по-умолчанию. :) Давайте лучше остановимся на черном цвете.

        2. Второй пункт разделить на:
        а) Выделяйте подзаголовки полужирным шрифтом большего размера (size=7 [опять же нужно придумать стандарт])
        б) Не используйте все цвета радуги. Человеку будет неудобно читать.
        в) Важные места в тексте выделяйте полужирным шрифтом или курсивом.
        г) Используйте больше текстовых коммментариев. Не все принципы можно объяснить голым кодом.

        3. (см. также 2г)). Как можно более подробно комментируйте код. Не выкладывайте лишние участки кода, только объясняемый материал.

        4. Полезно прикреплять к сообщению архив с исходниками готового проекта. В нем также приветствуются подробные комментарии.

        Заключение: У каждой хорошо оформленной статьи, в принципе, должны быть введение (в котором поставлены вопросы для решения) и заключение (как краткое резюме). Но это буквально в две строчки и очень коротко.
          Да, и еще, при объяснении особенностей работы с компонентами старайте свойства этих компоннетов выставлять в RUN TIME.
            0 пользователей читают эту тему (0 гостей и 0 скрытых пользователей)
            0 пользователей:


            Рейтинг@Mail.ru
            [ Script execution time: 0,0804 ]   [ 15 queries used ]   [ Generated: 11.12.24, 00:45 GMT ]