Ohjelman rekisteröinti GOST: n mukaan (miten). Nuoren taistelijan kurssi: Ohjelmadokumentaation suunnittelusta (dokumentaatio) Teknisten eritelmien nimeäminen automatisoidulle järjestelmälle

Tietokoneohjelmat laaditaan Unified Systemin vaatimusten mukaisesti ohjelman dokumentaatio(ESPD). ESPD - joukko GOST-standardeja, jotka määrittävät säännöt ohjelma-asiakirjojen suunnittelulle, sisällölle ja rakenteelle.
Tämä ohje sisältää otteita ESPD:stä. Täydelliset tiedot saa suoraan GOST:ista.

Lyhyt ohjelman suunnittelualgoritmi

Lyhyesti ohjelman suunnittelualgoritmi ja ohjelmadokumenttien tyypit on esitetty kuvassa. Rekisteröintiprosessi on kuvattu tarkemmin alla.

Ohjelma-asiakirjan rekisteröinti

Ohjelmadokumentti - asiakirja, joka sisältää ohjelmien kehittämiseen, valmistukseen, ylläpitoon ja toimintaan tarvittavat tiedot.

Jokainen yksittäinen vakuutusasiakirja laaditaan GOST 19.101-77, GOST 19.103-77, GOST 19.104-78, GOST 19.105-78, GOST 19.106-78, GOST 19.604-78 (yhteinen kaikille ESPD-asiakirjoille) vaatimusten mukaisesti. Yksityiskohtainen kuvaus GOST-tiedot ovat alla) ja GOST tietylle politiikkaasiakirjalle.

Ohjelmadokumenttien yleiset vaatimukset. GOST 19.105-78

Vaatimukset painetussa muodossa oleville ohjelmadokumenteille. GOST 19.106-78

GOST 19.106-78 määrittelee ohjelmadokumenttien suorittamista koskevat säännöt painetulle suoritustavalle.

On tärkeää huomata, että tämä GOST ei koske ohjelmadokumenttia "Ohjelmateksti".

Käytäntöasiakirjamateriaalit on oltava seuraavassa järjestyksessä:

  • Otsikko osa:
    • hyväksymislomake (ei sisälly asiakirjalehtien kokonaismäärään);
    • otsikkosivu (asiakirjan ensimmäinen sivu);
  • Tietoa osa:
    • huomautus;
    • sisältö arkki;
  • Pääosa:
    • asiakirjateksti (kuvioilla, taulukoilla jne.);
    • sovellukset;
    • termiluettelo, lyhenneluettelo, kuvioluettelo, taulukkoluettelo, aihehakemisto, luettelo viittausasiakirjoista;
    • kirjaus osa:
    • muuta rekisteröintilomaketta.

Annotaatio osoittaa ohjelman painoksen, hahmottaa lyhyesti asiakirjan tarkoituksen ja sisällön. Jos asiakirja koostuu useista osista, huomautus osoittaa osien kokonaismäärän. Asiakirjan sisältö sijoitetaan erilliselle (numeroidulle) sivulle (sivuille) huomautuksen jälkeen, jossa on otsikko "SISÄLTÖ", ei numeroitu osioksi ja sisältyy asiakirjan kokonaissivumäärään.

Tekstin muotoilu:

  • Ohjelmadokumentti suoritetaan arkin yhdelle puolelle kahdella aikavälillä; sallittu yhden tai puolentoista tauon jälkeen.
  • Tiivistelmä sijoitetaan erilliselle (numeroidulle) sivulle, jonka otsikko on "YHTEENVETO", eikä sitä numeroida osana.
  • Osion otsikot kirjoitetaan isoilla kirjaimilla ja sijoitetaan symmetrisesti tekstin oikeaan ja vasempaan reunaan nähden.
  • Alaotsikot kirjoitetaan kappaleesta pienillä kirjaimilla (paitsi ensimmäinen iso kirjain).
  • Sanojen tavutus otsikoissa ei ole sallittua. Älä laita pistettä otsikon loppuun.
  • Otsikon ja seuraavan tekstin sekä osion ja alaosion otsikoiden välisen etäisyyden tulee olla yhtä suuri:
    • kun asiakirja suoritetaan koneella - kaksi väliä.
  • Jaksoissa ja alajaksoissa, joiden teksti on kirjoitettu samalle sivulle edellisen osan tekstin kanssa, viimeisen tekstirivin ja seuraavan otsikon välisen etäisyyden tulee olla yhtä suuri:
    • kun asiakirja suoritetaan koneella - kolme koneella kirjoitettua väliä.
  • Jaksot, alakohdat, kappaleet ja alakohdat on numeroitava arabialaisilla numeroilla ja pisteellä.
  • Osassa tulee olla jatkuva numerointi kaikille tähän jaksoon sisältyville alajaksoille, kappaleille ja alakohdille.
  • Alakohtien numerointi sisältää tähän jaksoon sisältyvän osan numeron ja järjestysnumeron pisteellä erotettuna (2.1; 3.1 jne.).
  • Jos jaksoja ja alakohtia on, lisätään alakohdan numeroon pisteen jälkeen kappaleen ja alakohdan järjestysnumero (3.1.1, 3.1.1.1 jne.).
  • Asiakirjan tekstin tulee olla lyhyt, selkeä, väärintulkintamahdollisuutta poissulkeva.
  • Termien ja määritelmien on oltava yhdenmukaisia ​​ja vakiintuneiden standardien mukaisia, ja niiden puuttuessa - yleisesti hyväksyttyjä tieteellisessä ja teknisessä kirjallisuudessa, ja ne on esitettävä termiluettelossa.
  • Tarvittavat selitykset asiakirjan tekstiin voidaan tehdä alaviitteillä.
  • Alaviite on merkitty numerolla, jossa on hakasulke, joka on sijoitettu fontin yläleikkausviivan tasolle, esimerkiksi: "tulostuslaite2) ..." tai "paperi5)".
  • Jos alaviite viittaa yhteen sanaan, alaviite sijoitetaan suoraan tämän sanan viereen, mutta jos se viittaa koko lauseeseen, niin lauseen loppuun. Alaviiteteksti sijoitetaan sivun loppuun ja erotetaan päätekstistä 3 cm:n pituisella viivalla, joka on piirretty sivun vasempaan reunaan.
  • Kuvat, jos niitä on enemmän kuin yksi tässä asiakirjassa, on numeroitu arabialaisilla numeroilla koko asiakirjassa.
  • Asiakirjan kaavat, jos niitä on useampi kuin yksi, numeroidaan arabialaisilla numeroilla, numero sijoitetaan oikea puoli sivu suluissa kaavatasolla.
  • Kaavaan sisältyvien symbolien ja numeeristen kertoimien merkitys on ilmoitettava suoraan kaavan alapuolella. Kunkin merkin arvo tulostetaan uudelle riville siinä järjestyksessä, jossa ne on annettu kaavassa. Salauksen ensimmäisen rivin tulee alkaa sanalla "missä", ilman kaksoispistettä sen jälkeen.
  • Viittaukset standardeihin (paitsi yritysstandardeihin) ovat sallittuja ohjelma-asiakirjoissa, tekniset tiedot ja muut asiakirjat (esimerkiksi valtion valvontaelinten asiakirjat, Neuvostoliiton Gosstroyn säännöt ja normit). Kun viitataan standardeihin ja spesifikaatioihin, niiden nimi on ilmoitettu.
  • Sinun tulee viitata asiakirjaan kokonaisuutena tai sen osiin (ilmoittaen asiakirjan nimitys ja nimi, jakson tai liitteen numero ja nimi). Toistuvissa viittauksissa osaan tai sovellukseen ilmoitetaan vain numero.
  • Tekstin ja taulukoiden huomautukset sisältävät vain viite- ja selittäviä tietoja.
  • Yhtä nuottia ei ole numeroitu. Kirjoita sanan "Huomautus" jälkeen kohta.
  • Useat nuotit tulee numeroida peräkkäin arabialaisilla numeroilla pisteellä. Laita sanan "Huomautus" jälkeen kaksoispiste.
  • Sanojen lyhenteet tekstissä ja kuvien alla olevat kuvatekstit eivät ole sallittuja.
  • Hakemuksina voidaan laatia kuvitettua materiaalia, taulukoita tai aputekstiä.
  • Jokaisen hakemuksen tulee alkaa uusi sivu jossa on sana "LIITE" oikeassa yläkulmassa ja niillä on temaattinen otsikko, joka on kirjoitettu symmetrisesti tekstiin isoin kirjaimin.

GOSTissa on näytearkki, joka osoittaa kentät, sivutuspaikat ja salauksen.

G O S U D A R S T V E N Y S T A N D A R T S O YU Z A S S S R

Yhtenäinen ohjelmadokumentaatiojärjestelmä

 GOST 19.103-77

OHJELMIEN JA OHJELMA-ASIAKIRJIEN NIMETTÄMINEN

Yhtenäinen ohjelma dokumentointijärjestelmä.
Ohjelmien ja ohjelmadokumenttien indeksointi.

Esittelypäivä 01.01.80 alkaen

1. Tämä standardi määrittää tietokoneiden, kompleksien ja järjestelmien ohjelmien ja ohjelmistoasiakirjojen nimeämisen rakenteen niiden tarkoituksesta ja laajuudesta riippumatta.

2. Ohjelmien ja asiakirjojen nimeämisen tulee koostua pisteillä erotetuista merkkiryhmistä (kehittäjäorganisaation maakoodin ja koodin jälkeen), välilyönneistä (asiakirjan versionumeron ja asiakirjan tyyppikoodin jälkeen), yhdysviivoista (rekisteröintinumeron ja tämän tyyppinen asiakirjanumero).

3. Rekisteröintijärjestelmää ohjelmien ja ohjelma-asiakirjojen nimeämistä varten ollaan perustamassa.

Ohjelmien nimeämisen rakenne ja sen ohjelma-asiakirja - eritelmät:

A.B.XXXX-XX
Nimityksen yleinen osa / Maakoodi | | | |
ohjelmat ja ohjelmistot | Kehittäjäorganisaation koodi | | |
siihen liittyvät asiakirjat Rekisteröintinumero | |
Painosnumero (ohjelman) |
Tarkistuksen numero (asiakirjan osalta) |

4. Muiden politiikka-asiakirjojen nimeämisen rakenne:

A.B.XXXX-XX XX XX-X
Ohjelman nimeämisen yleinen osa | | | | |
ja sitä koskevat ohjelma-asiakirjat | | | | |
Asiakirjan versionumero | | | |
Asiakirjatyypin koodi | | |
Tämän tyyppisen asiakirjan numero | |
Asiakirjan osanumero |

5. Maan kehittäjän koodi ja organisaation (yrityksen) kehittäjän koodi annetaan määrätyllä tavalla.

Rekisteröintinumero määrätään liittovaltion ohjelmaluokituksen mukaisesti, joka on hyväksytty valtion standardilla vahvistetun menettelyn mukaisesti.

Ennen liittovaltion ohjelmaluokituksen hyväksymistä jokaiselle organisaatiolle (yritykselle) -kehittäjälle on sallittua antaa rekisteröintinumero nousevassa järjestyksessä, alkaen 00001 - 99999.

Ohjelman versionumero tai asiakirjan versionumero on määritetty nousevassa järjestyksessä 01 - 99.

6. Asiakirjan tyyppikoodi on määritetty standardin GOST 19.101-77 vaatimusten mukaisesti.

7. Tämän tyyppinen asiakirjanumero on annettu nousevassa järjestyksessä 01:stä 99:ään.

8. Saman asiakirjan osanumero on annettu nousevassa järjestyksessä 1 - 9.

Huomautus. Jos asiakirja koostuu yhdestä osasta, osan yhdysviivaa ja sarjanumeroa ei ilmoiteta.

9. Ohjelman eritelmän ja toiminta-asiakirjojen versionumeron on vastattava saman ohjelman painosnumeroa.

Uudelleenjulkaisu. marraskuuta 1987

Symbolitaulukko kuuluu palveluun Windows-ohjelmat, eli se on ilmainen ja on osa toimintaa Windows-järjestelmät. Sen avulla voit etsiä merkkejä, jotka eivät ole näppäimistössä, kopioida ne tietokoneen muistiin ja liittää ne sitten mihin tahansa sovellukseen.

Tämä taulukko on kaikki Windows-versiot: 10, 8, 7, Vista, XP. Ja se toimii samalla tavalla kaikkialla. Se on kuvattu yksityiskohtaisesti Windows 7:lle.

Symbolikartan löytäminen laitteestasi

Tämä voidaan tehdä jollakin seuraavista kolmesta vaihtoehdosta:

1) Haku-riville on syötettävä "merkkitaulukko" ilman lainausmerkkejä. Haun tuloksena tulee näkyviin linkki symbolitaulukkoon.

2) Joko päävalikossa: Käynnistä - Ohjelmat - Apuohjelmat - Järjestelmätyökalut - Symbolitaulukko.

3) Kolmas vaihtoehto on etsiä symbolitaulukko. Käytämme, eli:

  • Paina molempia Win+R-näppäimiä samanaikaisesti.
  • "Suorita"-ikkuna tulee näkyviin, johon kirjoitamme "charmap.exe" ilman lainausmerkkejä.
  • Napsauta sitten "OK" ja "Symbol Table" avautuu.

Merkkitaulukon avulla voit nähdä kaikki merkit, jotka sisältyvät mihin tahansa fonttiin. Tarkastellaan tätä erityisellä esimerkillä.

Windowsin merkkitaulukko Times New Roman fontille

Selvyyden vuoksi tämä taulukko on esitetty alla olevassa kuvassa:

Riisi. 1. Windowsin merkkitaulukko Times New Roman fontille. "Kappale" -symboli on korostettu. Kappaleen syöttönäppäimet on merkitty: Alt + 0167

Symbolien järjestys symbolitaulukossa on seuraava:

  • välimerkit tulee ensin
  • sitten numerot
  • englanninkieliset kirjaimet,
  • kielellisempi.
  • Ja vasta kaiken tämän jälkeen on symboleja, jotka eivät ole näppäimistössä, kuten: ⅜, ∆, ™, ₤ ja niin edelleen.

Kuinka kopioida symboli symbolitaulukosta ja sijoittaa se sinne, missä sitä tarvitaan?

Ehdotan tähän kahta tapaa:

  1. Kopioitu (symbolitaulukossa) - liitetty (jos vaaditaan).
  2. Pikanäppäinten (eli pikanäppäimien) käyttäminen.

Ensimmäinen tapa: Kopioitu taulukkoon - liitetty tarvittaessa.

Kopioimme (ei lataa, vaan kopioimme) symbolin Symbolitaulukossa, jotta se voidaan sijoittaa tilapäisesti tietokoneen (tai vastaavan laitteen) muistiin. Tätä väliaikaista muistia kutsutaan .

Tällaista puskuria tarvitaan merkin sijoittamiseksi tilapäisesti sinne ja sen liittämiseksi puskurista, johon haluamme nähdä tämän merkin. Siten symbolia ei ladata tietokoneen levylle, vaan se sijoitetaan tilapäisesti tietokoneen RAM-muistiin, eli leikepöydälle. Ja tästä puskurista käyttäjä voi lisätä merkin missä tahansa.

Katsotaanpa konkreettista esimerkkiä siitä, kuinka voit heittää symbolin taulukosta leikepöydälle ja sitten saada sen sieltä ja sijoittaa sinne, missä sitä tarvitaan.

Vastaanottaja kopio merkki tietokoneen muistiin, meidän on valittava se. Voit tehdä tämän napsauttamalla haluamaasi symbolia (numero 1 kuvassa 2).

Napsauta sitten "Valitse"-painiketta (2 kuvassa 2):

Riisi. 2. Napsauta haluttua symbolia ja paina "Valitse" -painiketta

Tämän seurauksena merkki päätyy "Kopioimaan"-riville (1 kuvassa 3). Jotta symboli ilmestyisi leikepöydälle, sinun on napsautettava "Kopioi"-painiketta (2 kuvassa 3):

Riisi. 3. Kopioi symboli taulukosta leikepöydälle

Siellä on myös nopea vaihtoehto:

Kaksoisnapsauta symbolia ja se kopioidaan leikepöydälle.

Sen jälkeen on vielä siirryttävä sopivaan sovellukseen (tai tekstieditori) Ja lisää kopioitu hahmo leikepöydältä.

Voit tehdä tämän asettamalla kohdistimen sovellukseen (in, tekstieditoriin jne.) oikeaan paikkaan ja painamalla kahta näppäintä Ctrl + V (ne suorittavat "Liitä" -komennon).

Jos se ei toimi Ctrl + V -näppäimillä, napsauta hiiren kakkospainikkeella kohtaa, jossa merkki sijoitetaan. Valikko avautuu, jossa napsautamme "Lisää" -komentoa. Tämän jälkeen kopioitu merkki tulee näkyviin.

Huomaa, että voit lisätä useita merkkejä kerralla Symbolitaulukon "Kopioi"-riville ja kopioida ne kaikki samanaikaisesti. Sitten kaikki kopioidut merkit lisätään kerralla tarpeen mukaan (muistioon, johonkin sovellukseen jne.)

Toinen tapa: kopioi merkki pikanäppäimellä

Jokaisella taulukon merkillä on oma näppäinyhdistelmänsä.

Oikealla Windows-symbolitaulukossa (3 kuvassa 3) näet, mitä näppäinyhdistelmää sinun tulee painaa lisätäksesi valitun symbolin tarvitsemaasi sovellukseen.

Esimerkiksi § kappaleen merkkiä varten paina Alt+0167, jolloin voit käyttää vain numeroita pienestä numeronäppäimistöstä.

Saat lisätietoja merkkien koodauksen tarkistamisesta käytännössä käyttämällä pientä numeronäppäimistöä. Tämä tapa syöttää merkkejä, jotka eivät ole näppäimistöllä, vaatii tiettyjä taitoja, ja luulen, että tavalliset käyttäjät käyttävät sitä harvoin.

Tietokonelukutaitoharjoitus:

1) Avaa Windowsin merkkikartta. Valitse fontti, jota käytät eniten. Etsi kaksi tai kolme merkkiä, jotka eivät ole näppäimistössä, valitse ja kopioi ne leikepöydälle.

2) Avaa tekstieditori (esimerkiksi Muistio) ja liitä siihen aiemmin leikepöydältä kopioidut merkit.

Video "Windows Character Map"

GOST 19.701-90
(ISO 5807-85)

Ryhmä T55

VALTIOIDEN VÄLINEN STANDARDI

Yhtenäinen ohjelmadokumentaatiojärjestelmä

ALGORITMIT, OHJELMAT, TIEDOT JA JÄRJESTELMÄT

Perinteiset nimitykset ja toteutussäännöt

Yhtenäinen järjestelmä ohjelmadokumentaatiolle. Data-, ohjelma- ja järjestelmävuokaaviot, ohjelman verkkokaaviot ja järjestelmäresurssikaaviot. Vuokaavioiden dokumentaatiosymbolit ja käytännöt

MKS 35.080*
OKSTU 5004

____________________
* Hakemistossa "Kansalliset standardit" 2012
MKS 01.080.50 ja 35.080. - Tietokannan valmistajan huomautus.

Esittelypäivä 1992-01-01

TIEDOT

1. Neuvostoliiton valtion tietojenkäsittelytieteen ja tietotekniikan komitean kehittämä ja käyttöön ottama

KEHITTÄJÄT

A.A. Mkrtumyan (kehitysjohtaja); A.L. Shchers, Dr. tekniikka. tieteet; A.N. Sirotkin, Ph.D. ist. tieteet; L.D. Raikov, Ph.D. tekniikka. tieteet; A.V. Lobova; osastojen välinen Työryhmä ESPD-standardien kehittämiseen

2. HYVÄKSYTTY JA Otettu käyttöön Neuvostoliiton valtion tuotteiden laadunhallinta- ja standardikomitean asetuksella, päivätty 26. joulukuuta 1990 N 3294

3. Tämä standardi on kehitetty soveltamalla suoraan kansainvälistä standardia ISO 5807-85 * "Tiedonkäsittely. Tietojen, ohjelmien ja järjestelmien lohkokaavioiden symbolit ja käytännöt, kaaviot ohjelmaverkot ja järjestelmäresurssit"
________________
* Pääset tekstissä mainittuihin kansainvälisiin ja ulkomaisiin asiakirjoihin ottamalla yhteyttä käyttäjätukipalveluun. - Tietokannan valmistajan huomautus.

4. GOST 19.002-80, GOST 19.003-80 ASIAKKA

5. TASAVALTA. tammikuuta 2010


Tätä standardia sovelletaan symboleihin (symboleihin) algoritmien, ohjelmien, tietojen ja järjestelmien skeemoissa ja siinä määritellään säännöt niiden kaavioiden suorittamiselle, joita käytetään näyttöön. monenlaisia tietojenkäsittelyongelmia ja niiden ratkaisukeinoja.

Standardi ei koske symbolien sisä- tai viereen sijoitettuja merkintöjä ja merkintöjä, jotka selventävät niiden suorittamia toimintoja.

Standardin vaatimukset ovat pakollisia.

1. YLEISET MÄÄRÄYKSET

1. YLEISET VAATIMUKSET

1.1. Algoritmien, ohjelmien, tietojen ja järjestelmien kaaviot (jäljempänä - kaaviot) koostuvat tietyn merkityksen omaavista symboleista, lyhyestä selittävästä tekstistä ja yhdistävistä viivoista.

1.2. Kaavoja voidaan käyttää eri yksityiskohtaisilla tasoilla, ja tasojen lukumäärä riippuu tietojenkäsittelytehtävän koosta ja monimutkaisuudesta. Yksityiskohtaisuuden tulee olla sellainen, että eri osat ja niiden välinen suhde ymmärretään kokonaisuutena.

1.3. Tämä kansainvälinen standardi määrittelee symbolit käytettäväksi tietojenkäsittelyn dokumentaatiossa ja antaa ohjeita käytännöistä, joita käytetään:

1) dataskeemat;

2) ohjelmasuunnitelmat;

3) järjestelmän toimintasuunnitelmat;

4) ohjelmien vuorovaikutuksen suunnitelmat;

5) järjestelmäresurssien kaaviot.

1.4. Standardissa käytetään seuraavia käsitteitä:

1) pääsymboli - symboli, jota käytetään tapauksissa, joissa prosessin tai tietovälineen tarkkaa tyyppiä (tyyppiä) ei tunneta tai varsinaista tietovälinettä ei tarvitse kuvailla;

2) erityissymboli - symboli, jota käytetään tapauksissa, joissa prosessin tai tietovälineen tarkka tyyppi (laji) tiedetään tai kun se on tarpeen varsinaisen tietovälineen kuvaamiseksi;

3) kaavio - graafinen esitys ongelman määrittelystä, analyysistä tai ratkaisumenetelmästä, joka käyttää symboleja toimintojen, datan, virtauksen, laitteiden jne. näyttämiseen.

2. JÄRJESTELMÄN KUVAUS

2.1. Data Schema

2.1.1. Dataskeemat näyttävät datan polun ongelmien ratkaisussa ja määrittelevät käsittelyvaiheet sekä käytetyt erilaiset tietovälineet.

2.1.2. Tietoskeema koostuu:

1) tietomerkit (tietomerkit voivat myös osoittaa tietovälineen tyypin);

2) tiedoilla suoritettavan prosessin symbolit (prosessisymbolit voivat myös osoittaa tietokoneen suorittamia toimintoja);

3) viivasymbolit, jotka osoittavat prosessien ja (tai) tietovälineiden välisiä tietovirtoja;

2.1.3. Datamerkit edeltävät ja seuraavat prosessimerkkejä. Tietomalli alkaa ja päättyy tietomerkeillä (poikkeuksena kohdassa 3.4 määritellyt erikoismerkit).

2.2. Ohjelmakaava

2.2.1. Ohjelmakaaviot näyttävät ohjelman toimintojen järjestyksen.

2.2.2. Ohjelman kaava koostuu:

1) prosessisymbolit, jotka osoittavat varsinaisia ​​tietojenkäsittelytoimintoja (mukaan lukien symbolit, jotka määrittävät kuljetettavan polun tietyin loogisin ehdoin);

2) viivasymbolit, jotka osoittavat ohjauksen kulun;

3) erikoismerkit, joita käytetään piirin kirjoittamisen ja lukemisen helpottamiseksi.

2.3. Järjestelmän toimintakaavio

2.3.1. Järjestelmän toimintakaaviot näyttävät toimintojen ohjauksen ja tietovirran järjestelmässä.

2.3.2. Järjestelmän kaavio koostuu:

1) tietomerkit, jotka osoittavat tiedon olemassaolon (tietomerkit voivat myös osoittaa tietovälineen tyypin);

2) prosessisymbolit, jotka osoittavat tiedoille suoritettavat toiminnot sekä seurattavan loogisen polun;

3) lineaariset symbolit, jotka osoittavat prosessien ja (tai) tietovälineiden välisiä tietovirtoja sekä prosessien välistä ohjausvirtaa;

4) lohkokaavion kirjoittamista ja lukemista helpottavat erikoismerkit.

2.4. Ohjelman vuorovaikutussuunnitelma

2.4.1. Ohjelman vuorovaikutuskaaviot näyttävät ohjelman aktivointien polun ja vuorovaikutuksen vastaavien tietojen kanssa. Kukin ohjelma vuorovaikutuskaaviossa näytetään vain kerran (järjestelmän toimintamallissa ohjelma voidaan näyttää useammassa kuin yhdessä ohjausvirtauksessa).

2.4.2. Ohjelman vuorovaikutussuunnitelma koostuu:

1) datasymbolit, jotka osoittavat datan olemassaolon;

2) prosessisymbolit, jotka osoittavat tiedoille suoritettavat toiminnot;

3) viivasymbolit, jotka edustavat prosessien ja datan välistä kulkua sekä prosessien aloitusta;

4) erikoismerkit, joita käytetään piirin kirjoittamisen ja lukemisen helpottamiseksi.

2.5. Järjestelmän resurssikaavio

2.5.1. Järjestelmäresurssikaaviot edustavat tehtävän tai tehtäväjoukon ratkaisemiseen tarvittavien tietolohkojen ja käsittelylohkojen konfiguraatiota.

2.5.2. Järjestelmän resurssikartta koostuu:

1) tietosymbolit, jotka edustavat tietokoneen syöttö-, lähtö- ja tallennuslaitteita;

2) prosessoreita edustavat prosessisymbolit ( keskusyksiköt, kanavat jne.);

3) lineaariset symbolit, jotka edustavat tiedonsiirtoa syöttö-tulostuslaitteiden ja prosessorien välillä sekä ohjauksen siirtoa prosessorien välillä;

4) erikoismerkit, joita käytetään piirin kirjoittamisen ja lukemisen helpottamiseksi.

Esimerkkejä järjestelmien toteuttamisesta on esitetty liitteessä.

3. SYMBOLIEN KUVAUS

3.1. Tietosymbolit

3.1.1. Perustietosymbolit

3.1.1.1. Data

Symboli edustaa dataa, tietovälinettä ei ole määritelty.

3.1.1.2. Tallennetut tiedot

Symboli näyttää tallennetun tiedon käsittelyyn sopivassa muodossa, tallennusvälinettä ei ole määritelty.

3.1.2. Tietyt datamerkit

3.1.2.1. RAM

Symboli edustaa hajasaantimuistiin tallennettuja tietoja.

3.1.2.2. Sarjamuistilaite

Symboli edustaa sarjamuistilaitteeseen (magneettinauha, nauhakasetti, nauhakasetti) tallennettuja tietoja.

3.1.2.3. Suora pääsy tallennuslaite

Symboli edustaa tietoja, jotka on tallennettu suorakäyttöiseen tallennuslaitteeseen (magneettilevy, magneettirumpu, levyke).

3.1.2.4. Asiakirja

Symboli edustaa telineessä olevia tietoja ihmisen luettavassa muodossa (kirjoituskone, optinen tai magneettinen asiakirja, mikrofilmi, nauharulla yhteenvetotiedoilla, tiedonsyöttölomakkeet).

3.1.2.5. Manuaalinen syöttö

Symboli näyttää tiedot, jotka on syötetty käsin käsittelyn aikana kaikenlaisista laitteista (näppäimistö, kytkimet, painikkeet, valokynä, viivakoodinauhat).

3.1.2.6. Kartta

Symboli näyttää telineessä kortin muodossa olevat tiedot (reikäkortit, magneettikortit, kortit, joissa on luettavat merkit, kortit, joissa on repäisytarra, kortit, joissa on skannatut merkit).

3.1.2.7. paperiteippi

Symboli näyttää telineellä paperiteipin muodossa olevat tiedot.

3.1.2.8. Näyttö

Symboli näyttää tiedot, jotka on esitetty ihmisen luettavassa muodossa kantajalla näyttölaitteen muodossa (näyttö visuaalista havainnointia varten, tiedonsyöttöilmaisimet).

3.2. Prosessin symbolit

3.2.1. Perusprosessin symbolit

3.2.1.1. Käsitellä asiaa

Symboli näyttää kaikenlaisen tietojenkäsittelytoiminnon (tietyn toiminnon tai toimintoryhmän suorittaminen, mikä johtaa tiedon merkityksen, muodon tai sijoituksen muutokseen tai sen määrittämiseen, mihin useista virtaussuunnista siirrytään).

3.2.2. Käsittele erityisiä symboleja

3.2.2.1. ennalta määritetty prosessi

Symboli näyttää ennalta määritellyn prosessin, joka koostuu yhdestä tai useammasta operaatiosta tai ohjelmavaiheesta, jotka on määritelty muualla (alirutiinissa, moduulissa).

3.2.2.2. Käsikäyttö

Symboli näyttää minkä tahansa henkilön suorittaman prosessin.

3.2.2.3. Valmistautuminen

Symboli edustaa käskyn tai käskyryhmän muunnelmaa, jonka tarkoituksena on vaikuttaa johonkin myöhempään toimintoon (kytkimen asettaminen, indeksirekisterin muokkaaminen tai ohjelman alustus).

3.2.2.4. Ratkaisu

Symboli edustaa päätös- tai kytkintyyppistä toimintoa, jossa on yksi tulo ja useita vaihtoehtoisia lähtöjä, joista yksi ja vain yksi voidaan aktivoida, kun on arvioitu tässä symbolissa määritellyt ehdot. Vastaavat laskentatulokset voidaan kirjoittaa näitä polkuja edustavien viivojen viereen.

3.2.2.5. Rinnakkaiset toiminnot

Symboli edustaa kahden tai useamman rinnakkaisen toiminnon ajoitusta.

Esimerkki

Huomautus. Prosessit C, D ja E eivät voi alkaa ennen kuin prosessi A on valmis; samoin prosessin F on odotettava prosessien B, C ja D valmistumista, mutta prosessi C voi alkaa ja/tai päättyä ennen kuin prosessi D alkaa ja/tai päättyy, vastaavasti.

3.2.2.6. syklin raja

Kaksiosainen symboli edustaa silmukan alkua ja loppua. Symbolin molemmilla osilla on sama tunniste. Alustusehdot, lisäys, lopetus jne. sijoitetaan symbolin sisään alkuun tai loppuun riippuen tilan tarkistavan toiminnon sijainnista.

Esimerkki 

3.3. Viivojen symbolit

3.3.1. Perusviivasymboli

3.3.1.1. Linja

Symboli edustaa tietovirtaa tai ohjausta.

Osoitinnuolia voidaan lisätä tarpeen mukaan tai luettavuuden parantamiseksi.

3.3.2. Rivikohtaiset symbolit

3.3.2.1. Ohjauksen siirto

Symboli edustaa suoraa ohjauksen siirtoa prosessista toiseen, joskus mahdollisuus palata suoraan aloitusprosessiin sen jälkeen, kun aloitusprosessi on suorittanut tehtävänsä. Ohjauksen siirron tyyppi on nimettävä symbolin sisällä (esim. pyyntö, puhelu, tapahtuma).

3.3.2.2. Linkki

Symboli edustaa tiedonsiirtoa viestintäkanavan kautta.

3.3.2.3. Pisteviiva

Symboli edustaa vaihtoehtoista suhdetta kahden tai useamman symbolin välillä. Lisäksi symbolia käytetään hahmottelemaan huomautettu alue.


Esimerkki 1

Kun yhtä useista vaihtoehtoisista lähdöistä käytetään tulona prosessiin tai kun lähtöä käytetään tulona vaihtoehtoisiin prosesseihin, nämä symbolit yhdistetään katkoviivoilla.

Esimerkki 2

Seuraavan prosessin tulona käytettävä lähtö voidaan liittää tähän tuloon katkoviivalla.

3.4. Erikoissymbolit

3.4.1. Liitin

Symboli edustaa uloskäyntiä piirin osaan ja sisäänkäyntiä piirin toisesta osasta, ja sitä käytetään katkaisemaan linja ja jatkamaan sitä muualla. Vastaavien liitinmerkkien tulee sisältää sama yksilöllinen nimitys.

3.4.2. Terminaattori

Symboli näyttää ulostulon ulkoiseen ympäristöön ja tulon ulkoisesta ympäristöstä (ohjelmakaavion alku tai loppu, ulkoiseen käyttöön ja tietojen lähde tai kohde).

3.4.3. Kommentti

Symbolia käytetään lisäämään kuvailevia kommentteja tai selittäviä huomautuksia selityksen tai huomautuksen vuoksi. Pisteviivat kommenttisymbolissa liittyvät vastaavaan symboliin tai voivat ympäröidä symboliryhmän. Kommenttien tai huomautusten teksti tulee sijoittaa lähelle rajoitusmuotoa.


Esimerkki

3.4.4. Kulkea

Merkkiä (kolme pistettä) käytetään kaavioissa osoittamaan merkin tai merkkiryhmän pois jättämistä, jos merkkien tyyppiä tai lukumäärää ei ole määritetty. Symbolia käytetään vain rivisymbolien sisällä tai niiden välissä. Sitä käytetään pääasiassa kuvaavissa kaavioissa yleisiä ratkaisuja tuntemattomalla määrällä toistoja.

Esimerkki

4. SÄÄNNÖT SYMBOLIEN KÄYTTÖÖN JA JÄRJESTELMIEN SUORITTAMISESTA

4.1. Symbolien käyttöä koskevat säännöt

4.1.1. Symbolin on tarkoitus tunnistaa graafisesti sen edustama toiminto, riippumatta symbolin sisällä olevasta tekstistä.

4.1.2. Kaavion symbolien tulee olla tasaisin välein. Liitäntöjen kohtuullista pituutta ja pitkien johtimien vähimmäismäärää tulee noudattaa.

4.1.3. Useimmat symbolit on suunniteltu sallimaan tekstin sisällyttäminen symboliin. Tämän kansainvälisen standardin määrittelemät symbolimuodot on tarkoitettu antamaan ohjeita todellisuudessa käytetyille symboleille. Kulmia ja muita symbolien muotoon vaikuttavia parametreja ei tule muuttaa. Symbolien tulee olla mahdollisimman yhtenäisiä.

Hahmoja voidaan piirtää missä tahansa suunnassa, mutta vaakasuora suunta on parempi aina kun mahdollista. Hahmon muodon peilikuva tarkoittaa samaa toimintoa, mutta ei ole suositeltava.

4.1.4. Vähimmäismäärä tekstiä, joka tarvitaan tietyn symbolin toiminnan ymmärtämiseen, tulee sijoittaa kyseiseen symboliin. Lukuteksti tulee kirjoittaa vasemmalta oikealle ja ylhäältä alas virtaussuunnasta riippumatta.

Esimerkki

Jos symbolin sisään mahtuvan tekstin määrä ylittää sen mitat, tulee käyttää kommenttisymbolia.

Jos kommenttisymbolien käyttö saattaa hämmentää tai häiritä kaavion kulkua, teksti tulee sijoittaa erilliselle arkille ja viitata symboliin.

4.1.5. Symbolitunnisteita voidaan käyttää skeemoissa. Tämä on symboliin liittyvä tunniste, joka identifioi symbolin viitetarkoituksiin muissa dokumentaatioelementeissä (esim. ohjelmaluettelossa). Symbolin tunniste on sijoitettava vasemmalle symbolin yläpuolelle.

Esimerkki

4.1.6. Kaavioissa voidaan käyttää symbolien kuvausta - mitä tahansa muuta tietoa, esimerkiksi osoittamaan symbolin erityiskäyttöä ristiviittauksella tai parantamaan funktion ymmärtämistä kaavion osana. Symbolin kuvaus tulee sijoittaa oikealle symbolin yläpuolelle.

Esimerkki

4.1.7. Järjestelmäkaavioissa tallennusvälineitä edustavat symbolit edustavat usein syöttö-/tulostusmenetelmiä. Jotta voidaan käyttää viittausta dokumentaatioon, tulostustapoja edustavien symbolien kaaviossa teksti tulee sijoittaa oikealle symbolin yläpuolelle ja syöttötapoja edustavien symbolien teksti tulee sijoittaa oikealle symbolin alle.

Esimerkki

4.1.8. Kaavioissa voidaan käyttää yksityiskohtaista esitystä, joka ilmaistaan ​​prosessin tai datan palkkisymbolilla. Palkin sisältävä symboli osoittaa, että muualla samassa dokumentaatiosarjassa on tarkempi esitys.

Raitasymboli on mikä tahansa symboli, jonka sisällä on vaakasuora viiva yläosassa. Tämän rivin ja symbolin ylimmän rivin väliin on sijoitettu tunniste, joka osoittaa tämän symbolin yksityiskohtaisen esityksen.

Päätemerkkiä on käytettävä sanallisen esityksen ensimmäisenä ja viimeisenä merkkinä. Päätteen ensimmäisen merkin tulee sisältää linkki, joka on myös paljaassa merkissä.

Symboli raidalla

Yksityiskohtainen näkymä

4.2. Yhteyssäännöt

4.2.1. Datavirrat tai ohjausvirrat kaavioissa esitetään viivoina. Virtaussuuntaa vasemmalta oikealle ja ylhäältä alas pidetään vakiona.

Tapauksissa, joissa kaavion on selkeytettävä (esimerkiksi kytkettäessä), viivoilla käytetään nuolia. Jos virtaus on muuhun kuin vakiosuuntaan, nuolien tulee osoittaa tämä suunta.

4.2.2. Viivoja tulee välttää kaavioissa. Leikkaavat viivat eivät ole loogisesti yhteydessä toisiinsa, joten suunnanmuutokset leikkauspisteissä eivät ole sallittuja.

Esimerkki

4.2.3. Kaksi tai useampi saapuva linja voidaan yhdistää yhdeksi lähteväksi linjaksi. Jos kaksi tai useampi rivi yhdistetään yhdeksi riviksi, yhdistämiskohtaa on siirrettävä.

Esimerkki

4.2.4. Kaavioissa olevien viivojen tulee lähestyä symbolia joko vasemmalta tai ylhäältä ja tulla joko oikealta tai alhaalta. Viivojen tulee suunnata kohti symbolin keskustaa.

4.2.5. Kaavioiden rivit tulee tarvittaessa katkaista turhien risteyksien tai liian pitkien viivojen välttämiseksi, ja myös jos kaavio koostuu useista sivuista. Raon alussa olevaa liitintä kutsutaan ulkoliittimeksi ja raon päässä olevaa liitintä sisemmäksi liittimeksi.

Ulkoinen liitin

Sisäinen liitin

4.3. Erikoissopimukset

4.3.1. Useita myyntipisteitä

4.3.1.1. Symbolista tulee näyttää useita ulostuloja:

1) useita rivejä tästä symbolista muihin symboleihin;

2) yksi rivi annetusta symbolista, joka sitten haarautuu vastaavaan määrään rivejä.

Esimerkkejä

4.3.1.2. Jokaiseen symbolilähtöön on liitettävä asianmukaiset ehtoarvot, jotka osoittavat sen edustaman loogisen polun, jotta kyseiset ehdot ja niihin liittyvät viittaukset tunnistetaan.

Esimerkkejä

4.3.2. Toistuva näkymä

4.3.2.1. Yhden symbolin ja siihen liittyvän tekstin sijaan voidaan käyttää useita symboleja kuvien päällekkäin, joista jokainen sisältää kuvaavaa tekstiä (useiden tallennusvälineiden tai tiedostojen käyttö tai luominen, useiden tulostettujen raporttien tai reikäkorttimuotojen kopioiden tuottaminen).

4.3.2.2. Kun useat merkit edustavat järjestettyä joukkoa, järjestyksen on oltava edestä (ensimmäinen) taakse (viimeinen).

4.3.2.3. Viivat voivat tulla päälle tai poistua mistä tahansa päällekkäisten symbolien kohdasta, mutta kohdan 4.2.4 vaatimusten on täytettävä. Useiden merkkien ensisijaisuus tai peräkkäinen järjestys ei muutu rivin saapumis- tai poistumispisteen mukaan.

Esimerkki

5. SYMBOLIEN KÄYTTÖ

Symbolin nimi

Data Schema

Ohjelmakaava

Järjestelmän toimintakaavio

Ohjelman vuorovaikutuksen kaavio

Järjestelmän resurssikaavio

Tietosymbolit

Main

Tallennetut tiedot

Erityinen

RAM

Sekvenssipääsymuisti

Suora pääsy tallennuslaite

Asiakirja

Manuaalinen syöttö

paperiteippi

Prosessin symbolit

Main

Erityinen

ennalta määritetty prosessi

Käsikäyttö

V.E. Karpov

Tämä asiakirja sisältää lyhyen kuvauksen ESPD-standardeista, jotka opiskelijoiden on tiedettävä täyttääkseen lukukausityöt ja ohjelmistojärjestelmien luomiseen liittyvät projektit. Lisäksi se voi olla hyödyllinen ohjelma-asiakirjojen laadun parantamisessa yleensä.

KÄYTTÖEHDOT (GOST 19.201-78)

1. Yleiset määräykset

KEHITTÄMISVAIHEET (GOST 19.102-77)

OHJELMAN KUVAUS (GOST 19.402-78)

OHJELMAN TEKSTI (GOST 19.401-78)

OHJELMA JA TESTAUSMENETELMÄT (GOST 19.301-79)

TULOSTUSMENETELMÄLLÄ VALMISTETUJEN OHJELMA-ASIAKIRJOJEN VAATIMUKSET (GOST 19.106-78)

Standardointi ohjelmistodokumentaation alalla

Miten eteenpäin

Asiakirjojen valmistelu ohjelmisto(PS) olemassa olevien GOST-standardien mukaisesti

2. Valtion yleiset ominaisuudet

2.3. Venäjän federaation valtion standardit (GOST R)

2.4. Kansainvälinen standardi ISO/IEC 12207: 1995-08-01

Ohjelmointityön ehkä epämiellyttävin ja vaikein vaihe on ohjelmadokumentaation luominen. Valitettavasti yleensä tätä joko ei opeteta ollenkaan tai parhaimmillaan he eivät kiinnitä riittävästi huomiota vastaanotettujen asiakirjojen laatuun. Tämän taiteen hallitseminen on kuitenkin usein yksi tärkeimmistä tekijöistä ohjelmoijan laadun määrittämisessä.

Ensinnäkin kyky luoda ohjelmadokumentaatio määrittää ohjelmoijan ammattitason. Asiakas ei syvenny upeimmankaan ohjelman hienouksiin ja ominaisuuksiin. Asiakas lukee asiakirjat ensin. Myös psykologisella tekijällä on tässä tärkeä rooli. Erityisesti entinen Neuvostoliiton ohjelmointikoulu arvostettiin (ja arvostetaan nyt) kaikkialla maailmassa. Nykyaikaisia ​​kotimaisia ​​ohjelmoijia ei enää noteerata. Luokka ei ole sama. Nykyään ohjelmia ei enää kirjoiteta, vaan käännetään (ja nämä ovat "kaksi suurta eroa"). Joten "klassiseen" tyyliin luotu ohjelmistodokumentaatiopaketti (jäljempänä PD) luo suotuisimman vaikutelman asiakkaallesi tai työnantajallesi. Varsinkin jos PD:n kirjoittaja välttää lauseita, kuten "klikkaa vierityspalkkia ...", "ruuvi" jne. Valitettavasti tällainen slängijuttu kätkee yleensä joko ajatusten puutteen tai täydellisen tyhjyyden (kirjoittaja teki lähtemättömän vaikutuksen erään hänen tuttavansa tarinasta tietystä "pelailijasta", joka joko "juttaili" jonkun kanssa tai harjoitti "maltia" Tai jotain sellaista.). PD:n kieli on eräänlainen byrokraattinen, hyvin konservatiivinen kieli. Sillä on oma erityinen viehätyksensä. Hyväksy, että termit kiintolevyasema, levykeasema, manuaalinen manipulaattori, kuten "hiiri" (tai "kolobok", kuten se oli jossakin vanhassa PD-paketissa) kuulostavat täysin erilaiselta kuin vastaavat "ruuvi", "flop" ja vain "hiiri". Asiat ovat muuten jo edenneet siihen pisteeseen, että jopa erikoisuuskin on kuulemma ilmestynyt - tekninen kirjailija, ts. henkilö, joka voi luoda ohjelmistodokumentaation.

Toiseksi, hyvin koottu (tarkemmin luotu) PD-paketti säästää sinut monilta ongelmilta. Erityisesti voit päästä eroon ärsyttävistä kysymyksistä ja perusteettomista väitteistä yksinkertaisesti ohjaamalla käyttäjän dokumentaatioon. Tämä koskee ensinnäkin tärkeintä asiakirjaa - toimeksiantoehtoja. Puhumme tästä alla, ja nyt voimme muistaa usean miljoonan dollarin oikeusjutun IBM:ää vastaan. Tämän kanteen nosti yksi suuri kustantamo, joka oli tyytymätön BT:n laatuun ja ohjelmisto. IBM voitti tapauksen. Ja hän voitti vain sen tosiasian ansiosta, että hän esitti molempien osapuolten allekirjoittaman toimeksiannon. Se oli kauan sitten, 70-luvulla, mutta se ei muuta asian ydintä.

Yksi asia vielä. On tärkeää luoda ensimmäinen PD-paketti. Tämä riittää rakentamaan kaikki seuraavat sen perusteella käyttämällä sitä mallina tai mallina. Mutta se on tehtävä erittäin hyvin. rauhassa. Erittäin perusteellinen.

Ensin sinun on aseistauduttava GOST: illa. GOST määrittelee kaiken. Erityisesti se sisältää myös meitä kiinnostavan Unified System for Program Documentation (ESPD). Ehkä vaikein asia on saada itse GOST. GOST:n tulee olla vain painetussa alkuperäisessä muodossa. Niitä myydään (ainakin ennen) erikoisliikkeissä. Erityisesti dokumentaation alan standardien hankkimiseksi voit ottaa yhteyttä seuraaviin organisaatioihin:

  • IPK "Standards Publishing House", tieteellisten ja teknisten asiakirjojen jakelun alueosasto ("Standards" -myymälä), 17961, Moskova, st. Donskaya, d. 8, puh. 236-50-34, 237-00-02, faksi/puh. 236-34-48 (koskee GOST:ia ja GOST R:ää).
  • Venäjän valtion standardin VNIIKI (lukusali), 103001, Moskova, Granatny per. 4, puh. 290-50-94 (kansainvälisten, ulkomaisten standardien ja muiden tieteellisten ja teknisten asiakirjojen osalta).

Eikä lainauksia ja toissijaisia ​​lähteitä. GOST on laki. Ja vielä enemmän, ei Internetiä (kuvittele, että tuomioistuin antaa tuomion rikoslain tulosteen avulla, joka on ladattu jostain sivustosta). Älä luota keneenkään muuhun kuin alkuperäiseen. Siitä huolimatta kirjoittajan on edelleen turvauduttava ESPD:hen, vapauttaen itsensä kaikesta vastuusta.

Aloitetaan yleisistä säännöksistä yhtenäinen järjestelmä ohjelmistodokumentaatio (jotka on myös määritelty vastaavassa standardissa GOST 19.001-77).

Yhtenäinen ohjelmadokumentaatiojärjestelmä on joukko valtion standardeja, jotka määrittävät toisiinsa liittyvät säännöt ohjelmien ja ohjelmadokumentaation kehittämiselle, suunnittelulle ja levittämiselle.

ESPD-standardit määrittelevät yleiset määräykset ja perusstandardit, kehitysdokumentaation täytäntöönpanosäännöt, valmistusasiakirjojen täytäntöönpanosäännöt, huoltodokumentaation täytäntöönpanosäännöt, käyttödokumentaation täytäntöönpanosäännöt, ohjelmadokumentaation ja muiden standardien käsittely. ESPD sisältää:

  • perustavaa laatua olevat sekä organisatoriset ja metodologiset standardit;
  • standardit, jotka määrittelevät tietojenkäsittelyssä käytettävien ohjelmadokumenttien muodot ja sisällön;
  • standardeja, jotka automatisoivat ohjelmadokumenttien kehittämisen.

Yleisesti ottaen ESPD-asiakirjojen luettelo on erittäin laaja. Se sisältää erityisesti seuraavat GOST:t:

  • GOST 19.001-77 ESPD. Yleiset määräykset.
  • GOST 19.101-77 ESPD. Ohjelmatyypit ja ohjelma-asiakirjat (julkaistu uudelleen marraskuussa 1987 muutoksineen).
  • GOST 19.102-77 ESPD. Kehitysvaiheet.
  • GOST 19.103-77 ESPD. Ohjelmien ja ohjelmadokumenttien nimeäminen.
  • GOST 19.104-78 ESPD. Peruskirjoitukset.
  • GOST 19.105-78 ESPD. Ohjelmadokumenttien yleiset vaatimukset.
  • GOST 19.106-78 ESPD. Vaatimukset painetussa muodossa oleville ohjelmadokumenteille.
  • GOST 19.201-78 ESPD. Tekninen tehtävä. Sisällön ja suunnittelun vaatimukset.
  • GOST 19.202-78 ESPD. Erittely. Sisällön ja suunnittelun vaatimukset.
  • GOST 19.301-79 ESPD. Ohjelma ja testimenettely.
  • GOST 19.401-78 ESPD. Ohjelman teksti. Sisällön ja suunnittelun vaatimukset.
  • GOST 19.402-78 ESPD. Ohjelman kuvaus.
  • GOST 19.404-79 ESPD. Selittävä huomautus. Sisällön ja suunnittelun vaatimukset.
  • GOST 19.501-78 ESPD. Lomake. Sisällön ja suunnittelun vaatimukset.
  • GOST 19.502-78 ESPD. Sovelluksen kuvaus. Sisällön ja suunnittelun vaatimukset.
  • GOST 19.503-79 ESPD. Järjestelmäohjelmoijan opas. Sisällön ja suunnittelun vaatimukset.
  • GOST 19.504-79 ESPD. Ohjelmoijan opas.
  • GOST 19.505-79 ESPD. Käyttöohje.
  • GOST 19.506-79 ESPD. Kielen kuvaus.
  • GOST 19.508-79 ESPD. Opas huolto. Sisällön ja suunnittelun vaatimukset.
  • GOST 19.604-78 ESPD. Säännöt tulostettavien ohjelmadokumenttien muutosten tekemiseksi.
  • GOST 19.701-90 ESPD. Algoritmien, ohjelmien, tietojen ja järjestelmien kaaviot. Yleissopimukset ja täytäntöönpanosäännöt.
  • GOST 19.781-90. Tietojenkäsittelyjärjestelmäohjelmistojen tarjoaminen.

Kuten näette, suurin osa ESPD-kompleksista kehitettiin 70- ja 80-luvuilla. Osittain nämä standardit ovat vanhentuneita, ja lisäksi niissä ei ole joitakin puutteita. Ensinnäkin ne eivät heijasta joitain nykyaikaisia ​​suuntauksia ohjelmien ja ohjelmadokumentaation suunnittelussa, ja toiseksi nämä standardit sisältävät useita päällekkäisyyksiä ohjelmadokumentaation fragmenteista. Paremman tavan puuttuessa on kuitenkin keskityttävä niihin.

Joten ESPD-standardit virtaviivaistavat ohjelmistojärjestelmien dokumentointiprosessia. Ensinnäkin ESPD-standardien edellyttämä ohjelmadokumenttien kokoonpano ei kuitenkaan ole ollenkaan niin "jäykkä" kuin miltä se saattaa näyttää: standardit sallivat lisätyypit sisällyttämisen ohjelmistojärjestelmän (PS) dokumentaatiosarjaan, ja toiseksi, asiakkaan vaatimusten perusteella joitakin muutoksia vakiintuneiden PD-tyyppien rakenteeseen ja sisältöön. Lisäksi voidaan todeta, että ESPD-standardit (ja tämä koskee myös kaikkia muita PS-alan standardeja - GOST 34, kansainvälinen standardi ISO / IEC jne.) ovat luonteeltaan neuvoa-antavia. Tosiasia on, että Venäjän federaation standardointilain mukaisesti näistä standardeista tulee pakollisia sopimusperusteisesti - ts. viitattaessa niihin PS:n kehittämistä (toimitusta) koskevassa sopimuksessa.

Ennen kuin siirryt tarkastelemaan ohjelmadokumentaation laatimista koskevia sääntöjä, on tarpeen tehdä seuraava huomautus. Jokaisen asiakirjan edelle on hyvä esittely. Esittely on yleinen. Relevanssista, tarpeellisuudesta jne. Urakoitsijan tarkoituksena on tässä osoittaa tämän työn tekemisen merkitys ja välttämättömyys. Alku on yleensä vakio: "Nyt olemassa olevat lukuisat järjestelmät ... ... avaavat todellisia näkymiä ..." jne. Tähän lisätään yleensä lainauksia eri henkilöiden puheista (tämä on puhtaasti psykologinen näkökohta): "...kuten sanottiin viime täysistunnossa, kongressissa, konferenssissa jne.). Voit myös aloittaa siitä, että ". .. Nykyään alkuperäiskansojen sosiaalisten ja taloudellisten muutosten aikakaudella ... jne. "Yleensä tärkeintä tässä ei ole liioitella sitä.

Ja kauemmas. Kehittäjä sekoittaa usein tuotettaan kuvaillessaan komponentin ja kompleksin käsitteet. Nämä ovat erityyppisiä ohjelmia. Komponentti määritellään "ohjelmaksi kokonaisuutena tarkasteltuna, joka suorittaa täydellisen toiminnon ja jota käytetään itsenäisesti tai osana kompleksia", ja kompleksi on "ohjelma, joka koostuu kahdesta tai useammasta komponentista ja (tai) komplekseista, jotka suorittavat toisiinsa liittyviä toimintoja. ja sitä käytetään itsenäisesti tai toisessa kompleksissa.

GOST:n mukaan tämä standardi (julkaistu uudelleen marraskuussa 1987) määrittää menettelyn teknisten eritelmien rakentamiseksi ja toteuttamiseksi tietokoneiden, kompleksien ja järjestelmien ohjelman tai ohjelmistotuotteen kehittämiseksi niiden tarkoituksesta ja laajuudesta riippumatta.

Meidän on oltava erittäin varovaisia ​​ja varovaisia ​​luodessasi sitä, koska. usein taitavasti (ja asiantuntevasti) laadittu TOR määrää kaiken työn onnistumisen. Asiakkaan kanssa sovitaan TOR:sta, joka yleensä pyrkii asettamaan mahdollisimman paljon ristiriitaisia ​​ja liiallisia vaatimuksia. Toimeenpanijan tehtävänä on päinvastoin helpottaa elämäänsä. Mutta kun molempien osapuolten allekirjoitukset on laitettu, on liian myöhäistä toistaa mitään.

Toimeksianto laaditaan A4- ja/tai A3-kokoisille arkeille pääsääntöisesti täyttämättä arkin kenttiä. Arkkien (sivujen) numerot on kiinnitetty arkin yläosaan tekstin yläpuolelle.

Tehdäkseen muutoksia ja lisäyksiä tekniseen taustaan ​​ohjelman tai ohjelmistotuotteen kehittämisen myöhemmissä vaiheissa, siihen julkaistaan ​​lisäys. Tehtävätehtävän lisäyksen yhteensovittaminen ja hyväksyminen tapahtuu tehtävänkuvauksen mukaisesti.

Toimeksiannon tulee sisältää seuraavat kohdat:

  • nimi ja laajuus;
  • kehittämisen perusta;
  • kehittämisen tarkoitus;
  • ohjelman tai ohjelmistotuotteen tekniset vaatimukset;
  • vaiheet ja kehitysvaiheet;
  • valvonta- ja hyväksymismenettely;
  • sovellukset.

Ohjelman tai ohjelmistotuotteen ominaisuuksista riippuen on sallittua selventää osioiden sisältöä, lisätä uusia osioita tai yhdistää niitä.

Luvussa Nimi ja laajuus ilmoittaa ohjelman tai ohjelmistotuotteen nimi, lyhyt kuvaus laajuudesta ja objektista, jossa ohjelmaa tai ohjelmistotuotetta käytetään.

Luvussa Kehittämisen perusta on määritettävä:

  • asiakirja (asiakirjat), joiden perusteella kehitys suoritetaan;
  • tämän asiakirjan hyväksynyt organisaatio ja sen hyväksymispäivämäärä;
  • nimi ja (tai) symboli kehitysaiheita.

Opetusprosessin erityispiirteiden osalta lähtökohtana voi olla kurssisuunnittelun toimeksianto, __.__ päivätty instituutin tilaus. N ___., sopimus __.__. varten N___. , ja niin edelleen.

Luvussa Kehittämisen tarkoitus ohjelman tai ohjelmistotuotteen toiminnallinen ja toiminnallinen tarkoitus on ilmoitettava. Voit rajoittaa itsesi yhteen tai kahteen lauseeseen täällä. Tärkeintä on määritellä selkeästi, mihin tämä ohjelma on tarkoitettu.

Esimerkiksi: Ohjelma on jatkuvien lineaaristen järjestelmien kehittäjän automatisoidun työaseman (AWS) ydin automaattinen ohjaus(ACS), jonka avulla käyttäjä voi ratkaista yksinkertaisten mallien analysointiongelmia.

Luku Tekniset vaatimukset ohjelmaan tai ohjelmistotuotteeseen tulee sisältää seuraavat alakohdat:

  • suorituskykyvaatimukset;
  • luotettavuusvaatimukset;
  • käyttöehdot;
  • teknisten välineiden koostumusta ja parametreja koskevat vaatimukset;
  • tietojen ja ohjelmistojen yhteensopivuusvaatimukset;
  • merkintöjä ja pakkaamista koskevat vaatimukset;
  • kuljetuksen ja varastoinnin vaatimukset;
  • erityisvaatimukset.

Toisin sanoen, tästä alkaa yksityiskohdat. Kuvaa, mitä ohjelman pitäisi tehdä ja miltä sen pitäisi näyttää.

suorituskykyvaatimukset. Tässä on ilmoitettava suoritettavien toimintojen koostumukseen, syöttö- ja lähtötietojen järjestämiseen, ajallisiin ominaisuuksiin jne. liittyvät vaatimukset.

Esimerkiksi: Ohjelman on sallittava ... laskea ... rakentaa ... luoda ...

Alkutiedot: tekstitiedosto tietyllä ...

Lähtötiedot: graafinen ja tekstitietoa- järjestelmäanalyysin tulokset…; tekstitiedostot - raportit ... järjestelmän tilan diagnosoinnista ja mahdollisista virheistä ilmoittamisesta.

luotettavuusvaatimukset. Vaatimukset luotettavan toiminnan varmistamiseksi (stabiilin toiminnan varmistaminen, tulo- ja lähtötietojen ohjaus, palautumisaika vian jälkeen jne.) tulee määritellä.

Täällä on vaikea "arvata" mitään. Parhaassa tapauksessa voi ohittaa muunnos, jossa ohjelmasi toimii vain täysin oikeilla tiedoilla. Yleensä Asiakas ei suostu tähän, mutta voit yrittää.

Esimerkiksi: Ohjelman on toimittava tutkittavan graafin tietyn laajennetun esiintymismatriisin kanssa toiminta-algoritmin mukaisesti, annettava virheilmoituksia, jos lähtötiedot on määritetty väärin, tuettava interaktiivista tilaa käyttäjälle tarjottujen ominaisuuksien puitteissa. .

Käyttöehdot. On määriteltävä käyttöolosuhteet (ilman lämpötila, suhteellinen kosteus jne. valituille tietovälinetyypeille), joissa määritellyt ominaisuudet on varmistettava, sekä palvelun tyyppi, tarvittava henkilöstömäärä ja pätevyys.

Tässä vaiheessa vaikeuksia ei yleensä esiinny. Valitettavasti asiakas on väistämättä antanut ymmärtää käyttäjän ammattitaidosta. Tämä on tietysti toinen syy löytää vikoja ohjelmassasi. Tässä voit kuitenkin rajoittua lauseisiin, kuten "Ohjelman käyttöolosuhteet ovat samat kuin IBM PC:n ja yhteensopivien tietokoneiden käyttöolosuhteet", "Ohjelman tulee olla suunniteltu ei-ammattimaiselle käyttäjälle." ja niin edelleen.

Vaatimukset teknisten välineiden koostumukselle ja parametreille. Ilmoittakaa vaadittu teknisten välineiden koostumus ja ilmoittakaa niiden tekniset ominaisuudet.

Tärkeintä tässä ei ole unohtaa mitään ja ennakoida kaikkea, toisaalta (muuten he lipsuttavat IBM PC / XT:tä yksivärisellä näytöllä ja ilman hiirtä), ja toisaalta, älä liioittele sitä lisääntyneen vaatimukset, muuten asiakas löytää mukautuvamman urakoitsijan.

Esimerkki: Tarvitset IBM PC -yhteensopivan tietokoneen, jossa on EGA (VGA) -näytönohjain. Vaadittu levytila ​​- vähintään 600 kt, vapaan määrä RAM-muisti- vähintään 400 kb. On toivottavaa, että sinulla on EMS-ajuri ja hiiri.

Tietojen ja ohjelmistojen yhteensopivuuden vaatimukset. Ominaisuudet ovat samat kuin edellisessä kappaleessa. Tässä tulee ilmoittaa tietorakenteita koskevat vaatimukset syöttö- ja tuloste- ja ratkaisumenetelmissä, lähdekoodeja, ohjelmointikielet. Tarvittaessa tiedot ja ohjelmat tulee suojata.

Esimerkiksi: Ohjelman on toimittava itsenäisesti MS DOS -versiossa 3.3 tai uudemmassa. Perusohjelmointikieli on Turbo Pascal 6.0.

Merkintä- ja pakkausvaatimukset sekä kuljetuksen ja varastoinnin vaatimukset ovat varsin eksoottisia. Yleensä tässä on ilmoitettu ohjelmistotuotteen merkintävaatimukset, pakkausvaihtoehdot ja -tavat. Ja kuljetusta ja varastointia koskevissa vaatimuksissa ohjelmistotuotteelle on ilmoitettava kuljetusehdot, varastointipaikat, varastointiolosuhteet, varastointiolosuhteet, varastointiajat erilaisissa olosuhteissa.

Erityisvaatimukset ovat erittäin vastuullinen asia. Niitä on parasta välttää niin paljon kuin mahdollista. Ja ilmoittaa siitä heti.

Esimerkiksi: Ohjelman aikaominaisuuksille ei ole erityisiä vaatimuksia. Ohjelman kapasitiivisille ominaisuuksille ei ole erityisiä vaatimuksia.

Tekniset ja taloudelliset indikaattorit. Tämä ohjelmoijan vaikein kohta ei ole aina olemassa. Sitä tarvitaan ensisijaisesti silloin, kun tavoitteenasi on perustella tehdyn työn valtava tehokkuus ja merkitys. Tämä tuote toimii yleensä erittäin hyvin asiakkaalle. Tämä on ainakin paras perustelu kehitystyön ajoitukselle ja kustannuksille.

Tässä osiossa tulee ilmoittaa: arvioitu taloudellinen tehokkuus, arvioitu vuositarve (esimerkiksi: arvioitu puhelujen määrä kokonaisuuteen vuodessa on 365 työkertaa), kehittämisen taloudelliset edut parhaisiin kotimaisiin ja ulkomaisiin näytteisiin verrattuna tai analogit.

Lisäksi on toivottavaa määritellä sekä ohjelman kehittämisen arvioidut kustannukset että ohjelmoinnin monimutkaisuus.

Vaiheet ja kehitysvaiheet(tästä lisää alla) määritä tarvittavat kehitysvaiheet, vaiheet ja työn laajuus (luettelo kehitettävistä, sovitettavista ja hyväksyttävistä ohjelma-asiakirjoista) sekä pääsääntöisesti kehittämisen aikajana ja määritä toteuttajat.

Vakiovaiheet kuvataan tässä. Tärkeintä on määrittää ajoitus oikein. Jos mahdollista, yritä jakaa vaiheet tasaisesti ajan (ja määrän) mukaan. Muista, että kaikki projektit eivät pääse viimeiseen vaiheeseen. Ja raportit pitäisi olla jokaisessa vaiheessa. Muista myös, että työprojekti vie eniten aikaa. Jos sinulla ei ole aikaa täyttää dokumentaatiota ajoissa, Asiakkaalla on täysi oikeus olla hyväksymättä työtä ollenkaan kaikista siitä aiheutuvista seurauksista.

Tärkeimmät ja välttämättömät vaiheet ja vaiheet ovat itse toimeksianto, luonnossuunnittelu, tekniset ja työsuunnitelmat.

  • Alustava suunnittelu. Tässä vaiheessa syöttö- ja lähtötietojen rakenteet kehitetään yksityiskohtaisesti, määritetään niiden esitysmuoto. Kehitetty yleinen kuvaus algoritmi, itse algoritmi, ohjelman rakenne. Ohjelman kehittämistä ja toteuttamista varten laaditaan toimintasuunnitelma.
  • Tekninen projekti. Se sisältää kehitetyn algoritmin ongelman ratkaisemiseksi sekä menetelmiä lähtötietojen hallintaan. Se kehittää myös virheenkäsittelytyökaluja ja diagnostisten sanomien antamista, määrittää lähtötietojen esitysmuodot ja teknisten välineiden konfiguraation.
  • Toimiva projekti. Tässä vaiheessa suoritetaan ohjelman ohjelmointi ja virheenkorjaus, ohjelmadokumenttien, ohjelmien ja testausmenetelmien kehittäminen. Testaus- ja virheenkorjausesimerkkejä valmistellaan. Dokumentaatio ja graafinen materiaali viimeistellään. Yleensä täsmennetään, että ohjelman kehittämisen aikana tulee laatia seuraavat asiakirjat:
    • ohjelman teksti;
    • ohjelman kuvaus;
    • ohjelma ja testausmenetelmät;
    • sovelluksen kuvaus;
    • käyttöohjeet.

Nämä ovat vakiovaatimuksia. Jos Asiakas hyväksyy sen, että tätä listaa ei voida toimittaa kokonaisuudessaan, tämä tarkoittaa, että hänen aikeensa sinua ja tuotettasi koskevat eivät ole vakavia.

Grafiikka voi olla saatavilla tai ei. Varsinkin kun et aio raportoida työsi tuloksista. Mutta vakavissa projekteissa tämä kohta vaaditaan.

Esimerkiksi: Ohjelman kehittämisen aikana tulee valmistella seuraava graafinen materiaali:

    • tekniset ja taloudelliset indikaattorit;
    • ohjelman rakenne;
    • muoto ohjelman syöttötietojen esittämiseksi;
    • algoritmin yleinen kaavio (2 arkkia);
    • laskennalliset perusalgoritmit;
    • esimerkki ohjelmasta.

Luvussa Valvonta- ja hyväksymismenettely testityypit ja yleiset vaatimukset työn hyväksymiselle on ilmoitettava. Mikäli mahdollista, ilmoita tässä kappaleessa, että "kehityksen valvonta ja hyväksyminen tapahtuu asiakkaan toimittamilla laitteilla", muuten saatat joutua tuomaan laitteet mukaasi.

Esimerkiksi: Kehityksen ohjaus ja hyväksyminen suoritetaan ohjaus- ja debug-esimerkkien testien perusteella. Tämä tarkistaa kaikkien ohjelman toimintojen suorittamisen.

SISÄÄN Sovellukset toimeksiantoon tarvittaessa johtaa:

  • luettelo kehittämistä tukevista tutkimuksista ja muista töistä;
  • algoritmikaaviot, taulukot, kuvaukset, perustelut, laskelmat ja muut dokumentit, joita voidaan käyttää kehityksessä;
  • muut kehityksen lähteet.

Tämä standardi määrittelee ohjelmien kehitysvaiheet, ohjelmadokumentaation sekä työn vaiheet ja sisällön:

Kehitysvaiheet

Työvaiheet

Tekninen tehtävä

Perustelut ohjelman kehittämistarpeelle

Ongelman muotoilu.
Lähdemateriaalien kokoelma.
Kehitettävän ohjelman tehokkuutta ja laatua koskevien kriteerien valinta ja perustelut.
Tutkimustyön tarpeen perustelut.

Tutkimustyö

Syöttö- ja lähtötietojen rakenteen määrittäminen.
Ongelmanratkaisumenetelmien alustava valinta.
Aiemmin kehitettyjen ohjelmien käytön tarkoituksenmukaisuuden perustelut.
Teknisten välineiden vaatimusten määrittäminen.
Perustus ongelman ratkaisemisen perustavanlaatuiselle mahdollisuudelle.

Toimeksiantojen laatiminen ja hyväksyminen

Ohjelman vaatimusten määrittäminen.
Toteutettavuustutkimuksen laatiminen ohjelman kehittämistä varten.
Ohjelman kehitysvaiheiden, vaiheiden ja ehtojen määrittely sekä sitä koskeva dokumentaatio.
Ohjelmointikielten valinta.
Tutkimustyön tarpeen määrittäminen myöhemmissä vaiheissa.
Toimeksiannon koordinointi ja hyväksyminen.

Alustava suunnittelu

Luonnossuunnitelman kehittäminen

Syöttö- ja lähtötietojen rakenteen alustava kehitys.
Menetelmien jalostaminen ongelman ratkaisemiseksi.
Algoritmin yleiskuvauksen kehittäminen ongelman ratkaisemiseksi.
Toteutettavuustutkimuksen kehittäminen.

Konseptisuunnittelun hyväksyntä


Suunnitteluluonnoksen koordinointi ja hyväksyminen

Tekninen projekti

Teknisen projektin kehittäminen

Syöttö- ja lähtötietojen rakenteen tarkentaminen.
Algoritmin kehittäminen ongelman ratkaisemiseksi.
Syöttö- ja lähtötietojen esitystavan määrittäminen.
Kielen semantiikan ja syntaksin määritelmä.
Ohjelmarakenteen kehittäminen.
Laitteiston kokoonpanon lopullinen määritelmä.

Teknisen projektin hyväksyminen

Toimintasuunnitelman laatiminen ohjelmien kehittämistä ja toteuttamista varten.
Selittävä huomautus.
Teknisen projektin koordinointi ja hyväksyminen.

työluonnos

Ohjelman kehittäminen

Ohjelman ohjelmointi ja virheenkorjaus

Ohjelmadokumentaation kehittäminen

Ohjelma-asiakirjojen kehittäminen GOST 19.101-77 vaatimusten mukaisesti.

Ohjelman kokeilut

Ohjelman ja testausmenetelmien kehittäminen, koordinointi ja hyväksyminen.
Alustavien tila-, osastojen välisten, hyväksymis- ja muiden testien suorittaminen.
Ohjelman ja ohjelmadokumentaation korjaus testitulosten perusteella.

Toteutus

Ohjelman valmistelu ja lähettäminen

Ohjelman ja ohjelmadokumentaation valmistelu ja siirto huoltoa ja (tai) tuotantoa varten.
Lain rekisteröinti ja hyväksyminen ohjelman siirtämisestä ylläpitoon ja (tai) tuotantoon.
Ohjelman siirto algoritmien ja ohjelmien rahastoon.

Huomautuksia:

  1. On sallittua sulkea pois toinen kehitysvaihe ja teknisesti perustelluissa tapauksissa toinen ja kolmas vaihe. Näiden vaiheiden tarve on ilmoitettu tehtävänkuvauksessa.
  2. Työvaiheita ja (tai) niiden sisältöä saa yhdistää, sulkea pois sekä ottaa käyttöön muita työvaiheita asiakkaan kanssa sovitulla tavalla.

Tämä standardi keskittyy tuloksena olevan kehitystuotteen dokumentointiin.

Tarkkaan ottaen on kaksi erilaista asiakirjaa, joilla on kuitenkin paljon yhteistä. Nämä ovat YLEINEN KUVAUS (GOST 19.502-78) ja OHJELMAN KUVAUS (GOST 19.402-78). Kuitenkin, koska on erittäin vaikeaa luoda laadullisesti sekä yhtä että toista, turvautumatta lähes täydelliseen päällekkäisyyteen, repeämään kappaleita, riittäisi toteuttaa yksi, yleisempi "hybridi" asiakirja. Kutsutaan sitä "Ohjelman kuvaukseksi".

Itse asiassa "Ohjelman kuvausta" sen sisällössä voidaan täydentää osioilla ja kappaleilla, jotka on otettu muiden kuvailevien asiakirjojen ja käsikirjojen standardeista: GOST 19.404-79 ESPD. Selittävä huomautus, GOST 19.503-79 ESPD. Järjestelmäohjelmoijan käsikirja, GOST 19.504-79 ESPD. Ohjelmoijan käsikirja, GOST 19.505-79 ESPD. Käyttöohje jne. Erityisesti selittävästä huomautuksesta voidaan ottaa algoritmin kaavio, yleinen kuvaus algoritmista ja (tai) ohjelman toiminnasta sekä perustelut hyväksytyille teknisille ja teknisille ja taloudellisille ratkaisuille.

Ohjelman kuvauksessa on välttämättä oltava tiedotusosa - huomautus ja sisältö.

Asiakirjan pääosan tulee koostua johdanto-osasta ja seuraavista osista:

  • toiminnallinen tarkoitus;
  • logiikan kuvaus.
  • Käyttöehdot;
  • koostumus ja toiminnot.

Ohjelman ominaisuuksista riippuen lisäosien lisääminen on sallittua.

SISÄÄN Johdanto-osa asiakirja tarjoaa yleistä tietoa ohjelmasta - koko nimi, nimitys, sen mahdollisia sovelluksia ja niin edelleen.

Esimerkiksi: Ohjelma "Automaattinen työpaikka ACS developer" on suunniteltu ... toteutettu .... Ohjelma tukee ...

Luvussa Tarkoitus ilmoittaa ohjelman tarkoitus ja antaa yleinen kuvaus ohjelman toiminnasta, sen tärkeimmistä ominaisuuksista, tiedot ohjelman laajuudelle asetetuista rajoituksista sekä ilmoittaa myös työssä käytettyjen elektronisten tietokoneiden ja laitteiden tyypit .

Esimerkiksi: Ohjelma on suunniteltu ratkaisemaan ongelmia ... Ohjelma on automatisoidun työpaikan ydin ...

Käyttäjällä on mahdollisuus ..., toteuttaa ..., suorittaa ..., analysoida ..., saada analyysin ja käsittelyn tulokset ..., rakentaa ... jne.

Luvussa " Logiikan kuvaus"osoita:

  • kuvaus ohjelman rakenteesta ja sen pääosista

(esimerkiksi: Ohjelma sisältää seuraavat:

  • käyttöliittymä,
  • moduuli kaavion polkujen määrittämiseen,
  • siirtofunktion laskentamoduuli,
  • moduuli amplitudi- ja vaihetaajuusominaisuuksien muodostamiseen,
  • moduuli vastauksen muodostamiseen polynomitoimintoon,
  • tekstieditori) .
  • toiminnon kuvaus osat ja niiden väliset yhteydet;

Esimerkiksi: Ohjelma koostuu kuudesta moduulista: liitäntämoduuli; määritelmämoduuli ...; laskentamoduuli ...; moduuli … jne.

Käyttöliittymämoduuli on rakennettu kahdentyyppisiin valintaikkunoihin: "kysymys-vastaus"-ikkunaan ja "valikko"-tyyppiseen valintaikkunaan. Käyttöliittymämoduuli hallitsee...

Määritelmämoduuli... Se on...

Laskentamoduuli... jne.

  • tiedot ohjelmointikielestä;

Esimerkiksi: Ohjelma on kirjoitettu kielellä ... kääntäjällä ...

  • kuvaus kunkin komponentin tulo- ja lähtötiedoista;

Esimerkiksi: INPUT DATA. Ohjelman syöttödata on tekstitiedosto, joka kuvaa tutkittavan järjestelmän kaavion laajennettua ilmaantuvuusmatriisia.

OUTPUT. Lähtö on:

  • näytöllä näkyvät graafiset ja tekstilliset tiedot (järjestelmäanalyysin tulokset);
  • tiedostot yhdessä graafisia formaatteja- kopiot kuvasta rakennetuista ominaisuuksista (taajuusvaste, vaihevaste jne.);
  • tekstitiedostot - tutkimusraportit;
  • diagnosoida järjestelmän tila ja raportoida mahdollisista virheistä.
  • kuvaus osien logiikasta (tarvittaessa on laadittava kuvaus ohjelmasuunnitelmista).

Ohjelmalogiikkaa kuvattaessa on linkitettävä ohjelman tekstiin.

Luvussa Koostumus ja toiminnot esitä kuvaus ohjelmien koostumuksesta ja toiminnoista, sovellettavista menetelmistä ongelmien ratkaisemiseksi.

Luvussa Hakemuksen ehdot ohjelman toteuttamisen edellyttämät edellytykset ilmoitetaan (vaatimukset tämän ohjelman ja muiden ohjelmien edellyttämille teknisille välineille, syöttö- ja tulostiedon yleiset ominaisuudet sekä organisatoriset, tekniset ja teknologiset vaatimukset ja ehdot jne. .).

Esimerkiksi: Ohjelmaa käytetään henkilökohtainen tietokone(PC) tyyppiä IBM PC/AT. Interaktiivisessa tilassa työskentelyyn käytetään näyttöä, näppäimistöä ja hiirtä. Grafiikkatilan tukemiseen tarvitaan EGA (VGA) -sovitin. Syöttötiedot tallennetaan levykkeille ja/tai kiintolevyille. Ohjelma toimii käyttöjärjestelmällä...

Viitemateriaalit (kuvitukset, taulukot, kaaviot, esimerkit jne.) voidaan sisällyttää kuvauksen liitteeseen.

Älä myöskään unohda lisätä käynnistysmoduulin nimeä sekä kuvausta koko menettelystä.

Soita ja käynnistä järjestelmä

Vaatimukset ohjelman tekstin suunnittelulle ovat melko yksinkertaisia ​​ja pätevälle ohjelmoijalle luonnollisia. Tärkeintä tätä dokumenttia luotaessa on, että ohjelman teksti on luettavissa.

Edelleen on pakollista laatia tiedottava osa - huomautukset ja sisältö.

Asiakirjan pääosan tulee koostua yhden tai useamman osion teksteistä, joille annetaan otsikot.

Jokainen teksti ohjelmatiedosto alkaa otsikolla, joka sanoo:

    • ohjelman nimi,
    • kirjoittaja,
    • ohjelman luomispäivä,
    • versionumero
    • viimeisen muutoksen päivämäärä.

Kommentit ovat pakollisia, samoin kuin tiukka sisennyssääntöjen noudattaminen. Muista, että jopa kyvyttömyys kirjoittaa ohjelmadokumentaatiota voi olla perusteltua. Ja ohjelman ruma teksti - ei koskaan. Viittauksia siihen, että tämä teksti on selvä tekijälle itselleen, ei oteta vakavasti. Ohjelmatekstejä ei pitäisi hävetä muiden ihmisten luettavaksi.

Alla on esimerkki tällaisesta hyvin luetusta ohjelmatekstistä (otettu Nikolai Gechtin verkkosivustolta, sähköposti: [sähköposti suojattu], http://users.omskreg.ru/~geht)

/* Windows-lähteet"98

Windows 98:n lähdekoodi */ #sisällytä "win31.h" #sisällytä "win95.h" #sisällytä "evenmore.h" #include "oldstuff.h" #include "billrulz.h" #include "monopoly.h" # define INSTALL = HARD char make_prog_look_big; void main() ( while(!CRASHED) ( display_copyright_message(); display_bill_rules_message(); do_nothing_loop(); if(first_time_installation) ( make_50_megabyte_swapfile(); do_nothing_loop(); totally_screw_up_andstro_HS(); (); disable_Netscape(); disable_RealPlayer(); disable_Corel_Products(); hang_system(); ) kirjoittaa_jotain (kaikki); display_copyright_message(); do_nothing_loop(); do_some_stuff(); if(still_not_crashed) ( display_copyright_message(); do_nothing_pension_1); (); do_nothing_loop(); ) ) if(detect_cache()) disable_cache(); if(fast_cpu()) (set_wait_states(paljon); set_mouse(nopeus, erittäin_hidas); set_mouse(toiminta, hyppy); set_mouse(reaktio, joskus ); ) /* printf("Tervetuloa Windows 3.11:een"); */ /* printf("Tervetuloa Windows 95:een"); */ printf("Tervetuloa Windows 98:aan"); if(system_ok()) crash(to_dos_prompt ) else system_memory = open("a:\swp0001.swp", O_CREATE); while(jotain) ( lepotila(5); get_user_input(); nukkua(5); act_on_user_input(); nukkua(5); ) luo_yleinen_suojausvika();

Tämä asiakirja sisältää kuvauksen siitä, mitä tulee tehdä ja kuinka varmistaa (ja vakuuttaa asiakas), että ohjelma toimii oikein. Itse asiassa tämä asiakirja on ratkaiseva hyväksyntätestien kannalta. Hyvin suunniteltu ohjelma ja testausmetodologia on avain hyväksymistodistuksen allekirjoittamiseen, ts. se, johon olet käyttänyt niin paljon aikaa ja energiaa.

Muodollisesti tätä GOST:ia käytetään suunnitteluasiakirjojen kehittämiseen ja testitöiden suorittamiseen ohjelmistojärjestelmän valmiuden ja laadun arvioimiseksi. Dokumentti sisältää kuvauksen testauksen kohteesta ja tarkoituksesta, vaatimukset ohjelma- ja ohjelmistodokumentaatiolle, testauksen keinot ja menettelytavat sekä kuvauksen testitapauksista.

Tämän asiakirjan osat on helpompi ja selkeämpi kuvata välittömästi esimerkkien muodossa.

Testiobjekti

Esimerkki: Testiobjekti on ohjelma ... joka on suunniteltu ...

Testauksen tarkoitus

Esimerkki: Ohjelman luotettavuuden tarkistaminen.

Ohjelman vaatimukset

Esimerkki: Ohjelman toiminta ei saa johtaa häiriöön (järjestelmän kohtalokkaaseen häiriöön). Vuoropuhelun organisoinnin tulisi tarjota suoja virheellisten tietojen syöttämiseltä. Ohjelman pitäisi antaa diagnostiikkaa järjestelmän tilasta ja ilmoituksia tapahtuneista virheistä ... ja niin edelleen.

Ohjelmistodokumentaatiota koskevat vaatimukset

Esimerkki: Testattavaksi esitettävän ohjelmadokumentaation kokoonpano:

  • ohjelman kuvaus (GOST 19.402-78);
  • testiohjelma ja menetelmät (GOST 19.301-79);
  • ohjelmateksti (GOST 19.401-78).

Testauskeinot ja -menettely

Esimerkki: Ohjelma toimii MS DOS:n (versio 3.0 tai uudempi) käyttöolosuhteiden mukaisesti PC:ssä, kuten IBM PC/AT, sekä yhteensopiva sen kanssa. Käyttöön tarvitaan myös EGA (VGA) -sovitin.

TESTAUSMENETTELY:

    1. Ohjelma käynnistyy...
    2. Valittu…
    3. Painettu...
    4. Peräkkäin valittu...

Testitapaukset

Esimerkki: Testausta varten tarjotaan ..., jonka kuvaus on tiedostoissa ... Testitiedostojen sisältö ja ohjelman tulokset on esitetty liitteessä 1.

Ja lopuksi, harkitse viimeisintä ESPD-standardia, jota kutsutaan

Tämä standardi määrittelee säännöt tietokoneiden, kompleksien ja järjestelmien ohjelma-asiakirjojen toteuttamiselle niiden tarkoituksesta ja laajuudesta riippumatta ja jotka ESPD-standardeissa edellyttävät.

Yleiset vaatimukset. Kirjoituskoneella, koneella ja käsin kirjoitettuihin ohjelmadokumentteihin tulee syöttää yksittäisiä sanoja, kaavoja, symboleja (käsin piirustusfontilla), latinalaisten ja kreikkalaisten aakkosten kirjaimia sekä täydentää kaavioita ja piirustuksia mustalla musteella tai muste.

Suorituksen aikana havaitut painovirheet ja graafiset epätarkkuudet voidaan korjata pyyhkimällä huonosti suoritettu tekstin osa (piirustus) ja lisäämällä korjattu teksti (grafiikka) samalle arkille joko kirjoituskoneella tai mustalla musteella asiakirjan suoritustavasta riippuen.

Asiakirjaarkkien vaurioituminen, täplät ja epätäydellisesti poistetun tekstin (grafiikka) jäljet ​​eivät ole sallittuja.

Ohjelma-asiakirjat laaditaan A4-kokoisille arkeille. Sitä paitsi:

  • suunnittelu A3-kokoisille arkeille on hyväksyttävää;
  • asiakirjojen koneellisella suoritusmenetelmällä sallitaan poikkeamat A4- ja A3-muotoa vastaavien arkkien koosta käytettävien teknisten keinojen ominaisuuksien mukaan; A4- ja A3-formaatin arkeille, jotka edellyttävät tietojen tulostuslaitteiden tulostusominaisuuksia, kun asiakirja tehdään koneella;
  • kun asiakirja tehdään typografisesti, on mahdollista käyttää typografisten muotojen arkkeja.

Ohjelma-asiakirjan materiaalien sijainti suoritetaan seuraavassa järjestyksessä:

  • otsikko osa:
    • hyväksymislomake (ei sisälly asiakirjalehtien kokonaismäärään);
    • otsikkosivu (asiakirjan ensimmäinen sivu);
    • tieto osa:
    • huomautus;
    • sisältö arkki;
    • pääosa:
    • asiakirjateksti (kuvioilla, taulukoilla jne.);
    • luettelo termeistä ja niiden määritelmistä;
    • lyhennelista;
    • sovellukset;
    • aihehakemisto;
    • luettelo viiteasiakirjoista;
  • kirjaus osa:
    • muuta rekisteröintilomaketta.

Dokumentin rakentaminen. Tarvittaessa asiakirja on sallittu jakaa osiin. Jako osiin suoritetaan tasolla, joka ei ole alempi kuin osa. Jokainen osa täytetään erikseen, kun taas ensimmäisen osan sisällön lopussa tulee listata muiden osien nimet.

Asiakirjaan saa sisällyttää ohjelmatekstin osia, jotka on laadittu sen kielen sääntöjen mukaisesti, jolla ohjelmateksti on kirjoitettu.

Tiivistelmä sijoitetaan erilliselle sivulle (sivuille), joka on varustettu otsikolla "YHTEENVETO", numeroitu ja sisällytetty asiakirjan sisältöön.

Kunkin asiakirjan teksti jaetaan tarvittaessa kappaleisiin ja kappaleet alakohtiin riippumatta siitä, onko asiakirja jaettu osiin, osiin ja alakohtiin vai ei.

Osion otsikot kirjoitetaan isoilla kirjaimilla ja sijoitetaan symmetrisesti tekstin oikeaan ja vasempaan reunaan nähden. Alaotsikot kirjoitetaan kappaleesta pienillä kirjaimilla (paitsi ensimmäinen iso kirjain). Sanojen tavutus otsikoissa ei ole sallittua. Älä laita pistettä otsikon loppuun. Jokainen osa on suositeltavaa aloittaa uudelta arkilta.

Jaksot, alakohdat, kappaleet ja alakohdat on numeroitava arabialaisilla numeroilla ja pisteellä. Osioilla on oltava sarjanumero (1, 2 jne.)

Asiakirjan teksti. Asiakirjan tekstin tulee olla lyhyt, selkeä, väärintulkintamahdollisuutta poissulkeva. Termien ja määritelmien on oltava yhdenmukaisia ​​ja vakiintuneiden standardien mukaisia, ja niiden puuttuessa - yleisesti hyväksyttyjä tieteellisessä ja teknisessä kirjallisuudessa, ja ne on esitettävä termiluettelossa.

Tarvittavat selitykset asiakirjan tekstiin voidaan tehdä alaviitteillä. Alaviite on osoitettu numerolla, jonka hakasulke on sijoitettu fontin yläreunan tasolle.

Jos alaviite viittaa yhteen sanaan, alaviitteen merkki sijoitetaan suoraan tämän sanan viereen, mutta jos se viittaa koko lauseeseen, niin lauseen loppuun. Alaviiteteksti sijoitetaan sivun loppuun ja erotetaan päätekstistä 3 cm:n pituisella viivalla, joka on piirretty sivun vasempaan reunaan.

Kuvituksia. Kuvitukset voivat sijaita asiakirjan tekstissä ja (tai) sovelluksissa. Kuvat, jos niitä on enemmän kuin yksi tässä asiakirjassa, on numeroitu arabialaisilla numeroilla koko asiakirjassa.

Liitteissä kuvat on numeroitu kunkin liitteen sisällä asiakirjan päätekstin mukaisessa järjestyksessä. Viittaukset kuviin on annettu tyypeittäin: "Kuva 12" tai "(Kuva 12)". Kuvissa voi olla temaattinen otsikko ja kuvateksti, joka selittää kuvituksen sisällön.

Kaavat. Asiakirjan kaavat, jos niitä on useampi kuin yksi, numeroidaan arabialaisilla numeroilla, numero sijoitetaan sivun oikeaan reunaan, suluissa kaavan tasolla. Koko tositteen tai sen osien sisällä, kun asiakirja jaetaan osiin, kaavoissa on jatkuva numerointi.

Tekstissä olevat viittaukset kaavan järjestysnumeroon annetaan suluissa, esimerkiksi: "kaavassa (3)". Kun asiakirja jaetaan osiin, osanumero sijoitetaan ennen kaavan järjestysnumeroa ja erotetaan viimeisestä pisteestä, esimerkiksi: "kaavassa (1.4)".

Kaavaan sisältyvien symbolien merkitys on ilmoitettava suoraan kaavan alapuolella. Kunkin merkin arvo tulostetaan uudelle riville siinä järjestyksessä, jossa ne on annettu kaavassa. Ensimmäisen salauksenpurkurivin tulee alkaa sanalla "jos", ilman kaksoispistettä sen jälkeen.

Linkit. Viittaukset standardeihin ja muihin asiakirjoihin ovat sallittuja politiikka-asiakirjoissa. Sinun tulee viitata asiakirjaan kokonaisuutena tai sen osiin (ilmoittaen asiakirjan nimitys ja nimi, jakson tai liitteen numero ja nimi).

On sallittua ilmoittaa vain asiakirjan ja (tai) osien nimitys ilmoittamatta niiden nimiä. Linkit yksittäisiin alakohtiin, kappaleisiin ja toisen asiakirjan kuviin eivät ole sallittuja. Asiakirjan sisältämät viittaukset kappaleisiin, kuviin ja yksittäisiin alakohtiin ovat sallittuja.

Huomautuksia. Tekstin ja taulukoiden huomautukset sisältävät vain viite- ja selittäviä tietoja. Yhtä nuottia ei ole numeroitu. Kirjoita sanan "Huomautus" jälkeen kohta. Useat nuotit tulee numeroida peräkkäin arabialaisilla numeroilla pisteellä. Sanaa "huomautus" seuraa kaksoispiste. Muistiinpanojen tekstit saa tulostaa vain yhdellä välilyönnillä.

Lyhenteet. Sanojen lyhenteet tekstissä ja kuvien alla olevat kuvatekstit eivät ole sallittuja, paitsi:

  • GOST 2.316-68:ssa vahvistetut ja yleisesti venäjäksi hyväksytyt lyhenteet;
  • lyhenteet, joita käytetään osoittamaan ohjelmia, niiden osia ja toimintatapoja, työnohjauskielissä, ohjelman asetustyökaluissa jne., merkitty latinalaisilla kirjaimilla.

Sovellukset. Hakemuksina voidaan laatia kuvitettua materiaalia, taulukoita tai aputekstiä. Sovellukset on suunniteltu jatkoksi Tämä asiakirja seuraavilla sivuilla tai erillisenä asiakirjana.

Jokaisen hakemuksen on aloitettava uudelta sivulta sana "Hakemus" oikeassa yläkulmassa ja oltava temaattinen otsikko. Jos asiakirjassa on useampi kuin yksi hakemus, kaikki hakemukset numeroidaan arabialaisilla numeroilla (ilman numeromerkkiä), esimerkiksi:

Liite 1, Liite 2 jne.

Kun hakemus jätetään erillisenä asiakirjana, asiakirjan nimen alla tulee olla otsikkosivulla sana "Hakemus" ja jos hakemuksia on useita, myös sen järjestysnumero.