DocumentationНачало работы с документацией


Версии

Версия Дата выхода
Частная бета-версия 2016-03-26
1 2016-07-25
2 2016-08-04
3 2016-08-29
4 2016-09-12
5 2016-09-29
6 2016-10-20
7 2016-11-29

О документации

Что можно документировать?

  • Примеры функций для разных языков.
  • Краткое введение каждого тега.

В чем разница между вопросом и темой?

  • Темы имеют более широкий охват, чем вопросы; темы документации, которые задаются как вопрос, могут быть закрыты, потому что они слишком широкие.
  • Темы должны иметь несколько примеров; запрос, который может обслуживаться темой с одним примером (например, одним блоком кода), вероятно, слишком узкий.

Привет, мир

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

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