fkn.ktu10 Как оформлять вопросы/ответы по программированию -- подготовка программистов

Эта заметка относится к нашим программам обучения, а также ко всем тем у кого есть вопросы).

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

Какие вопросы/решения задач следует выносить на сайт

Достаточно одного из пунктов:

  • Этот вопрос (и ответ на него) может пригодиться другим участникам (не важно -- теория это или практика)
  • В вашем вопросе есть программный код, который надо подсвечивать (или иные фрагменты, которые для удобного восприятия требуют оформления для улучшения восприятия).
  • Вам прямо рекомендуют вынести вопрос на сайт (обычно в ситуации, когда придётся у вас придётся выяснять дополнительные детали)

Как задавать вопросы

Желательно:

  1. Для начала поищите по сайту (средствами движка или через гугл)-- вдруг на ваш вопрос уже есть ответ.
  2. Вопросы можно задавать (или выкладывать задачки на проверку) на форуме в соответствующем разделе, например в разделе PHP или разделе другого языка.
  3. Один вопрос -- одна "тема" на форуме.
  4. Код надо подсвечивать (см. как) и вообще использовать средства оформления а также добавлять ключевые слова.
  5. Стараться соблюдать соглашения по оформлению кода (например, для PHP).
  6. Если вопрос по какому-то фрагменту текста из других материалов сайте, то добавьте в текст ссылку, например: для вопроса по задаче в тексте ссылки укажите номер задачи и номер и/или название урока, в котором эта задача находится.

Примеры оформления:

Оформления решения задач

Убедитесь в вашем сообщении:

  • Условие задачи: либо в комментариях к коду -- как тут (что удобно самому решающему, ведь он может видеть это условие во время решения задачи, например в онлайн-интерпретаторе), либо просто цитатой как тут.
  • Обратная ссылка на список задач (как, например, там), в тексте ссылки укажите номер задачи и номер и/или название урока, в котором эта задача находится

Примеры оформления решений задач: