Інструкцыя па апісанні сэрвісаў партала www.Corpus.by


Гэты дакумент з’яўляецца стандартам падрыхтоўкі і афармлення дакументаў апісання – даведак (дапаможнікаў, help’аў) да сэрвісаў платформы “www.corpus.by”. Ён уключае ў сябе інфармацыю па наступных аспектах:

– патрабаванні да структуры дакумента даведкі;

– патрабаванні да афармлення дакумента даведкі;

– прыклады рэкамендаванага апісання сэрвісаў.

Правілы, вызначаныя ў патрабаваннях, з’яўляюцца абавязковымі для выканання ўсімі распрацоўшчыкамі апісанняў сэрвісаў. Гэты дакумент з’яўляецца адкрытым, таму самімі карыстальнікамі і распрацоўшчыкамі даведак могуць быць унесены прапановы па паляпшэнні стандарту, якія будуць разгледжаны і ўзгоднены з удзельнікамі суполкі “Corpus.by”.

 

Патрабаванні да структуры даведкі

Кожны дакумент даведкі павінны ўключаць наступныя вылучаныя асобнымі блокамі часткі:

 

Загаловак. Пункт змяшчае поўную назву сэрвісу на беларускай мове, але не ўключаючы само слова “сэрвіс”. Напрыклад, “Пошук і сартаванне алафонаў”, “Генератар інфармацыі аб сімвалах” і г.д.

 

Апісанне сэрвісу

У дадзеным пункце павінна быць каротка адлюстравана, якую задачу выконвае сэрвіс, пазначаны тып уваходных і выніковых дадзеных, абмежаванні па гэтых параметрах (калі ёсць). Пункт павінны пачынацца са слоў: «Сэрвіс “Канвертар азбукі Морзэ” дазваляе/прызначаны…». Прыкладны памер пункта – 5-6 сказаў.

 

Асноўныя тэрміны і паняцці

Пункт павінны ўключаць у алфавітным парадку спецыяльныя назвы ці тэрміны, якія адносяцца да працы сэрвісу.

Напрыклад:

Частата асноўнага тону – гэта параметр маўленчага сігналу, які…”, “Складанае фанетычнае слова (фанетычнае слова) – гэта слова разам са службовымі словамі, якія да яго прымыкаюць і не маюць ўласнага націску”.

 

Практычная каштоўнасць

Пункт павінны ўключаць мэты распрацоўкі і практычную каштоўнасць сэрвісу, а таксама прыклады, у якім кантэксце ён можа быць выкарыстаны. Прыкладны памер пункта – 5-6 сказаў.

 

Асаблівасці сэрвісу

Пункт павінны ўключаць апісанне асаблівасцяў сэрвісу. Напрыклад, такімі асаблівасцямі могут з’яўляцца факты выкарыстання пэўных слоўнікаў ці спецыфічных слоўнікаў, выкарыстанне спецыфічнага алгарытму пераўтварэння ці апрацоўкі інфармацыі. Прыкладны памер пункта – 5-6 сказаў.

 

Апісанне інтэрфейсу карыстальніка

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

 

Карыстальніцкі(я) сцэнар(ы) працы з сэрвісам

Змяшчае пакрокавае апісанне паслядоўнасці выбару тых ці іншых варыянтаў і спосабаў апрацоўкі ўведзенай інфармацыі (камбінацыі выбару розных опцый, слоўнікаў, рэжымаў і да г.п.). Кожны сцэнар павінны мець нумар і назву. У канцы кожнага сцэнара павінны быць прыведзены скрыншот з атрыманымі вынікамі апрацоўкі.

 

Мадэль, алгарытм

Змяшчае мадэль і алгарытм, па якіх працуе сэрвіс. Мадэль – матэматычная схема працы сэрвісу. Алгарытм – пакрокавы парадак звароту да пэўных фармальных элементаў, які пачынаецца з уводу і сканчваецца вывадам. Увага! Дадзены пункт пішацца не самастойна, а з дапамогай распрацоўшчыка сэрвісу. Студэнты, якія пішуць хэлп у рамках праходжання практыкі, могуць не пісаць дадзены пункт.

 

Спасылкі на крыніцы

Змяшчае спасылку на сам сэрвіс, а таксама спасылкі, якія могуць і не прысутнічаць у тэксце апісання, але з’яўляюцца карыснымі пры разглядзе сэрвіса (публікацыі, інтэрнэт-старонкі з тэматычнай інфармацыяй).

 

Перакрыжаваныя спасылкі

Змяшчае пранумараваныя ў квадратных дужках спасылкі, на якія абапіраюцца тыя ці іншыя сцверджанні ў тэксце апісання.

 

Патрабаванні да афармлення даведкі  

Кожная з пералічаных частак з’яўляецца асобным разделам дакумента, які абмежаваны абзацам і загалоўкам другога узроўню.

Рэкамендавана пазбягаць абаротаў, якія ўключаюць займеннікі, напрыклад, “я прапанаваў”, “ён апрацоўвае” і г. д.

 

Прыклады рэкамендаванага апісання сэрвісаў

Апісанне паводле дадзенай інструкцыі мае сэрвіс “Графічнае адлюстраванне контуру асноўнага тону”, якое можна пабачыць па спасылцы.

Спампаваць (PDF, 619KB)

If you have found a spelling error, please, notify us by selecting that text and pressing Ctrl+Enter.