Документация по API

Dec 18, 2010 07:47

Когда я только начинал документировать процедурный API, была создана единственная страница и на ней - всё-всё-всё:

www.solarix.ru/for_developers/api/grammar-engine-api.shtml

По мере роста объема описания пришлось вынести на отдельные страницы:

API морфологического анализатора www.solarix.ru/for_developers/api/morphology-analyzer-api.shtml

API синтаксического анализатора www.solarix.ru/for_developers/api/syntax-analyzer-api.shtml

API движка N-грамм www.solarix.ru/for_developers/api/ngrams-api.shtml

Потом все новые модули получали по возможности отдельные страницы с описанием функций:

Лемматизатор www.solarix.ru/for_developers/api/lemmatizator-api.shtml

Классификатор www.solarix.ru/for_developers/api/classifier-api.shtml

Наконец, я начал выносить детальное описание функций, с пояснениями и примерами кода, на отдельные страницы. Страниц описаний уже очень много, поэтому даю только ссылку на страницы со списками, откуда есть уже постраничные ссылки:

Список функций API www.solarix.ru/api/ru/list.shtml

API functions reference www.solarix.ru/api/en/list.shtml

процедурный API

Previous post Next post
Up