Руководство по стилю документации

Раздел поддержки пользовательского интерфейса

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

Пример:

Ссылка на документацию по Substrate

Где возможно, вставьте подсказку со ссылкой на соответствующую страницу документации Substrate.dev. Выделите жирным шрифтом текст «Substrate Documentation» и вставьте ссылку.

Пример:

Substrate Documentation for Treasury Module

Примечания параметров

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

Пример

Parameter Note: This hint block should name the parameter and state the current setting.