Последната актуализация на този раздел е от 2019 година.

 

 

3.5   ПРАВИЛА  ЗА  ОФОРМЯНЕ  НА  ТЕХНИЧЕСКАТА  ДОКУМЕНТАЦИЯ

 

 

      Навярно читателят разбира, че представянето на разработения проект не може да се състои единствено от чертежи. Та нали дори когато купуваме нова вещ, заедно с нея намираме и описание за нейното ползване. Ето защо е логично да се знае как следва да се представи един проект, щото и други, освен нас, да могат да го четат и разбират, да го оценяват, променят, доразвиват и реализират.

      Проектът се представя чрез следният примерен състав от документи, който естествено зависи от характера на проекта и авторския стил на проектанта:

·         Титулен лист;

·         Техническо задание;

·         Анотация;

·         Съдържание;

·         Въведение;

·         Обзорно-аналитична част и формулиране на подзадачите;

·         Основна обяснителна част на синтезираните решения;

·         Раздел на изследванията и експерименталните резултати;

·         Различен вид ръководства, които са изисквани според заданието;

·         Раздел на икономическо обосноваване на взетите технически решения;

·         Раздел, поясняващ специфичните изисквания за охрана на труда;

·         Заключение

·         Списък на използваната и цитирана литература;

·         Други документи

·         Приложения.

      Повечето техническите документи са лично творческо дело на проектанта и тяхното структуриране и оформяне не е регламентирано. Целта при изготвянето им естествено следва да бъде максимум разбираемост и полезност.

      Титулният лист е първият лист във всеки отчет или проект. В неговата горна част се записва официалното наименование на организацията (ведомството), която се явява изпълнител на проекта и (с по-малки букви) нейните подразделения (отдели, звена). Ето защо проектантът добре следва да разбира, че той не представя само себе си, но и организацията, от чието име работи. В тази връзка, той също трябва да бъде добре запознат с авторското право и интерпретацията на собственост върху творческите резултати. Възможно е тези въпроси да бъдат специално уговорени в техническото задание на проекта.

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

      Техническото задание на проекта се изготвя в резултат на първия и втория етап в процеса на проектиране, както беше пояснено в пункт 1. Най-общото схващане за същността на техническото задание е договор. Този “договор” се подписва от възложител, изпълнител, ръководител, консултант, финансист и всички други представители, имащи определена роля в дейностите, предвидени при разработване на проекта. В официалните случаи той съдържа и съответните печати, с което може да се даде юридическа сила на документа.

      Анотацията към проекта е необходима на читателя, за да се информира кратко за същността на проекта и неговите цели, основните принципи и методи за решаване на поставените проблеми, както и основните резултати, получени при неговото изпълнение. По обем анотацията не е желателно да надвишава една страница.

      Въведението следва да изразява тенденциите в развитието на изчислителната техника в направлението, отнасящо се към проблемите на проекта. В този смисъл въведението обосновава актуалността на проекта и полезността на очакваните резултати.

      В раздела на обзорно-аналитична част и формулиране на подзадачите авторът (авторите) следва кратко да изложи направените от него проучвания на националните и световните литературни източници във връзка с изследваното текущо състояние на разработваната тематика. Следва да изложи аналитично положителните и отрицателните констатации и изводи относно съществуващите методи за проектиране, за известните технически решения на различните нива на детайлизация. На тази основа се обосновава подробно техническото задание, което се разработва в проекта.

      Основната обяснителна част обикновено съдържа няколко подраздела, в които се излагат най-общо казано мотивите за взетите от проектанта конкретни и окончателни решения. За тази цел се излагат подробни обяснения за структурирането на проблема, за формулиране на подзадачите, за избраните схемни решения, за избраните методи и методики, както и всички направени изчисления, подкрепящи взетите решения или направените изводи. Въз основа на количествените оценки се правят качествените оценки. Излагат се отделните схемни решения, въпросите на конструирането и технологията на завършените елементи. Особено ясно следва да се изложат мотивите на автора, довели до всяко конкретно схемно решение и в тази връзка как са му повлияли такива условия като налична (липсваща) елементна база, съществуваща (несъществуваща) технологична възможност, наличие (отсъствие) на определени ресурси и др.

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

      Експерименталните резултати, които са получени в лабораторни условия, или в полеви, в производствени условия или други някакви условия, трябва да са органически свързани с проекта и неговите елементи. Необходимо е подробно да се опишат постановката, организацията и целите на проведените експерименти. Необходимо е да се опише методиките за обработка на получените данни и формулиране на съответните изводи от извършените работи. Особено внимание заслужават експериментите за изявяване на граничните възможности на реализираните решения. Особено важно е да се установи степента на съответствие между теоретичните и експерименталните резултати.

      Тъй като всяко техническо решение трябва да служи на човека, въпросът за охраната на човешкия труд е особено актуален при новите разработки и той следва да се има предвид още в процеса на проектиране. Необходимо е да се изложат изчисленията, доказващи безопасността на предвидените условия в съответната конструкция – изолация, разстояния, излъчвания, вибрации, температури, условия за запалване и пр. На основата на съответния анализ следва да се изложат ясно и конкретно правилата, които трябва да се спазват при работа с проектираното устройство.

      В заключението авторът излага кратко и обобщено основните резултати, които са получени в процеса на работа върху проекта, като привежда препоръки за практическото внедряване на разработката.

      Оформянето на текстовата част е много отговорна дейност, тъй като от това зависи дали изложеното от автора ще бъде разбрано и възприето. Структурирането на изложението е дело на автора. Всяка структурна единица се препоръчва да започва на нова страница. Изключение могат да правят структурните единици от по-ниските нива, които могат да започват и от текущата страница, но след пропуск поне на 2-3 празни реда. Всеки раздел (част, глава, параграф, пункт и пр.) следва да има своето наименование, което трябва да изразява кратко същността на изложението, поставено зад него. Тези наименования не се подчертават и в техния край не се поставя точка. Страниците се номерират последователно, като за първа се счита титулната. Нейният номер обаче не се изписва. Номера не се поставят още на листите от оризова хартия, съдържащи чертежи или фигури. Номерът на такъв лист се поставя върху празния бял лист под него, т.е. листът от оризова хартия, заедно с белия лист след него, се считат за една страница. Текстът може да бъде изложен само от едната страна на листите. Ако се използуват и двете страни на листите, четни номера следва да получат левите страници, а нечетни – десните. Освен това авторът трябва да се запознае и да спази типографските параметри, за да бъде възможно правилното подвързване на документите на проекта.

 

 

            Език и стил на изложението

      Описанието на извършената от автора на проекта работа е неизбежно лично негово дело и той трябва да приеме този факт. Това затруднява много от технократите, но задължението е неотменимо и всеки, който го е поел трябва да го изпълни с подобаваща отговорност.

      Стилът на научния език представлява особен безличен монолог. Текстът обикновено се поднася в безлична форма, например: “на базата на логическата структурна схема на устройството, се проектират принципните логически схеми на отделните логически възли”. Местоименията за първо и второ лице (аз, ти) никога не се употребяват.

      Станало е неписано правило авторът в научния документ да говори “от свое име” в множествено число, например: “... и като отчитаме бързата сходимост на този алгоритъм, приемаме това като основно негово достойнство”. Този феномен има своята историческа мотивация. Чрез този стил се изразява уважението към поколенията творци на научния прогрес, без чието наследство днешните творци биха били върнати в далечното минало. И още нещо в тази връзка, читателят следва добре да разбира, че творческите резултати не възникват в човешките глави от само себе си, някак си “изведнъж”. Трудно е да се обясни как точно човешкото съзнание генерира в определен и неочакван момент гениалната идея на дадено решение. Но авторът на тази книга е дълбоко убеден, че това е възможно в съзнанието само на професионално образован човек, който се е трудил упорито върху дадения проблем, изучил е и е оценил творчеството на своите предшественици, познава отлично разработените от тях методи, техните достойнства и недостатъци, дълбоко и истински е изстрадал проблемите върху които работи и много пъти си е лягал с разочарование и надежда. Авторът е убеден още, че такива възможности са заложени в различна степен у всеки от нас, и когато всеки от нас намери истинското си призвание, тогава необходимите условия за изявено творчество са в най-добрата комбинация.

      Има книги и научни трудове, в които се чувства блестяща ерудиция и талантливо перо, и четейки ги човек започва да си мисли, че посвещавайки се на науката, техните автори са лишили света от своя писателски талант. Не са редки случаите обаче, когато читателят трябва да положи много усилия, за да разбере какво са искали да кажат авторите.

      Не маловажен е въпросът на научната етика. Пишещият следва да изрази уважение към авторите, резултатите на които използва, цитира или дори критикува. Подреждането на авторите в литературния списък е само един от тези моменти. Добрият изследовател и творец не се предоверява на чуждите резултати. Но добрият стил не е съвместим с арогантност, надменност или мнителност. Бъдете справедливи и с чувство за мярка.

      Езикът е основата, върху която се осъществява комуникацията в науката и чрез който се съхраняват научните знания. Най-доброто писане в науката се отличава с краткост, яснота и точност. Стилът Ви трябва да се придържа към следните правила:

·         Не използвайте метафора, подобна на някоя, която вече сте видели отпечатана;

·         Не използвайте дълга дума, където и кратката върши работа;

·         Ако може да изхвърлите от текста някоя дума, правете го винаги;

·         Никога не използвайте страдателен залог, ако можете да използвате действителен;

·         По-добре да нарушите всички тези правила, отколкото да кажете или напишете нещо нелитературно.

 

 

            Съкращения

      Много честото употребяване на местоимението “ние” също не се препоръчва, ето защо множественото число на автора се изразява чрез по-сложни литературни форми, например може да се напише така: “… по наше мнение …”.

      Означаването на количествената информация в техническите текстове е прието да става в числов вид, например “принципната схема от фигура 12 съдържа 120 логически елемента И”. Числителните имена, означаващи някакъв ред, могат да се записват и с думи, например “в пети ред, единадесета колона, стои числото –5,60 …”, или още “третата таблица съдържа …”. Често се прилага и изписване на число, последвано от тире и някакво окончание, например “2-чен брояч”, или още “2/10-чен суматор”, с което се цели опростяване на текста.

      Глаголните конструкции на речта представляват основната част от информацията в изреченията. В техническите текстове обикновено се използва сегашно или минало време. Препоръчва се използването на кратки, ясни и не съставни изречения.

      В техническите текстове се използват много съкращения за означаване на наименованията на административни звена, на длъжности, на научни степени и звания, на териториални единици, на производствени звена и отдели и т.н. Съкращенията от този тип трябва да са еднакви във всеки отделен текст. Съкращенията не се разделят при пренос в края на текстовия ред. Употребата на нестандартни съкращения не се отличава от употребата на отделните думи. Правилата за тяхното съставяне са чисто граматически. Съкращения от тип абревиатура се съставят от първите букви на думите, например ТУ - (Технически Университет). Употребяват се и съкращения, в които е изпусната средната част на думата, например “с-ма” означава “система”. Ако едно съкращение се повтаря много пъти в хода на текста, то се съставя и указва в скобки при първата му среща, както тук е направено със съкращението УГО – условно графично означение, в началото на пункт 3.

      В качеството на съкращения на съответните думи не бива да се използват техните еквивалентни символи като например №, %, мнемонични означения на математически функции, като например  и други подобни. В текста смисълът на тези символи се изписва с думи, например “… ефектът е изразен в проценти …”.

 

 

            Цитати и позоваване

      В техническите текстове често се налага да се обръща внимание на информацията, съдържаща се в различни таблици, илюстрации, литературни източници. Указанията към тези части от текстовите документи се изписват с думи, и това не представлява трудност, тъй като това става чрез техните собствени указатели, например  “… на фигура 3.1.1 е изобразена общата логическа …”. Ако авторът желае да не разкъсва изречението, указателите се поставят в малки скоби, без техният текст да участвува непосредствено в изречението.

      Когато авторът не иска да излага в текста дадена теза или твърдение, което не е негово лично дело, а само споделяно положение, той може да се позове на съответния литературен източник, където читателят в пълна степен би могъл да се запознае, изучи или използува указаната информация. Тъй като литературните източници, които са използувани при разработката на проекта, трябва да бъдат описани, то позоваването става чрез изписване на поредния номер на източника, според списъка им, заграден с квадратни скобки, например “Известно е [36], че системата от елементарни логически функции И-НЕ е функционално пълна, следователно …”. Квадратните скобки са общо приети за този тип указатели. Чрез тях авторът показва също използването на чужди резултати. Източниците следва да бъдат подредени в списъка в онзи ред, в който се срещат позоваванията към тях в основния обяснителен текст. Често обаче се изисква азбучна или някаква друга подредба. Разбира се има и други системи, тъй като порядковата система, която бе спомената по-горе, има сериозен недостатък, който е свързан с необходимостта да се вмъкват нови източници. Така се налага нова номерация на следващите в списъка източници, откъдето пък се налага промяна на техните указатели в основния текст. В това отношение азбучната система е изключително удобна. Същността й е следната – указателят има следния вид  [LLLYY] или [КККГГ], където LLL са 3 главни латински букви (първите от фамилията на цитирания автор, първия в списъка от автори). Следват 2 цифри YY, последните от означението на годината на публикуване на цитираната публикация. Подобен е смисълът на втория кортеж, в който ККК са главни букви на кирилица, следвани от 2 цифри на годината на публикуване, например [ТЯН98] следва да съответства на публикация от списъка: “Тянев, Д.С., хххх ... хххх , 1998 г.”

      Цитатите от такива източници, които авторът привежда в подкрепа на своите мисли, трябва да са логически свързани с неговия текст, в противен случай те ще останат неразбрани. При това изреченията или фразите от оригиналния текст се цитират или в пълна степен. Със съкращения цитат може да бъде приведен, когато авторът иска да изведе на преден план същността му, ако тя е изложена в съответния източник по-просторно, отколкото му е необходимо. В цитатите се запазват всички препинателни знаци от оригиналния текст (запетаи, точки, кавички и пр.). Цитираният текст се поставя в кавички и може да бъде самостоятелно изречение или съставна част от изречението на автора. Цитатът може да бъде вмъкнат в изречението по различен и достатъчно сложен начин, включително с указателя на литературния източник и съответната страница, например:

      Дуализмът на Айнщайн маса-енергия е основанието на Е. Клингман да напише

“На ред е осъзнаването на още един дуализъм: апаратни средства-програмно осигуряване, който очевидно, ще има важно практическо значение.”,  [3, стр. 19, 4-ти абзац].

 

 

            Формули

      Математическите формули могат да се записват направо в текста на изречението или да се изнасят в отделен ред. Формулите се номерират само ако са много. При това се номерират само тези от тях, които ще бъдат упоменавани в последствие. Номерата на формулите се структурират така, че да се намира по-бързо тяхното място в текста. Структурата на номера се състои от номера на структурната единица на текста, където се изписва формулата – (5.3.1.12), което означава глава 5-та, параграф 3.1, поредна на формула 12. Необяснените до момента на изписване на формулата нейни параметри се обясняват веднага след това. Пренос на формулата на нов ред се извършва на мястото на основен знак за действие (с изключение на знак за деление) със задължителното му повтаряне в началото на новия ред. Когато формулата заема няколко реда, номерът й се поставя срещу последния ред. Когато се означава с един номер съвкупност от няколко формули, същият се поставя зад фигурна скоба в средата (вертикално) на заетото от формулите място. Многоточие във формулите се състои винаги от три точки, като знаците за събиране и изваждане се повтарят (Х+…+Х) или (В - А1 - А2 -…- А15). Тъй като знакът за действие умножение е точка, при многоточие във формулата допълнителни точки не се слагат. При изброяване или изреждане се слагат запетаи след всеки елемент и след многоточието също: 0, 2, 4, 6, …, 2.i, …, 200.

 

 

            Таблици

      Таблиците имат шапка и тяло. Тялото съдържа елементите, които имат структурата на шапката. Преди да се попълни една таблица се конструира нейната шапка. Шапката на таблицата в повечето случаи изразява логиката на данните съдържащи се в нея. Същността на структурните елементи на шапката се означават с ясен и кратък текст. Таблиците се номерират, като се изписва и думата “таблица”. Номерирането се подчинява на същите правила, посочени по-горе за формулите. Таблиците могат да имат и свои наименования, които се изписват над самите таблици, но под техния номер, например таблицата на истинност за логическата функция И:

 

Таблица 3.12   Таблица на истинност на функцията конюнкция

X

Y

Z

0

0

0

0

1

0

1

0

0

1

1

1

 

 

            Списък на използваната литература

      Използваните от автора литературни източници (книги, статии, отчети) се посочват в отделен списък, според реда на тяхното цитиране.

      За книгите се указва следна информация: име на автора (обикновено фамилия и инициали), име на книгата, име на издателството, седалище (град) на издателството, година на издаване, ISBN-номер и пр..

      За статиите се указва следната информация: име на автора, наименование на статията, име на списанието, класификационен номер, година, пореден номер, начална и крайна страница. Ако авторите са много, имената им се изреждат като се разделят със запетаи. Мястото на списъкът се посочва задължително в съдържанието на техническата документация.

      Когато цитираният източник е публикация в ИНТЕРНЕТ, е необходимо да се посочи още означението [Electronic resource], както и адресът за достъп:  Mode of access: http://www.XXXXXXXXX.

 

 

 

Следващият раздел е:

4.  Проектиране на устройство за умножение на два вектора