Dokumentáció

A dokumentáció minden olyan kommunikálható anyag, amelyet egy tárgy, rendszer vagy eljárás egyes jellemzőinek leírására, magyarázatára vagy oktatására használnak, mint például annak részei, összeszerelése, telepítése, karbantartása és használata. A tudásmenedzsment és a tudásszervezés egy formájaként a dokumentáció papíron, online, vagy digitális vagy analóg médián, mint például hangszalag vagy CD, is elérhető. Példák erre a felhasználói útmutatók, fehér könyvek, online súgók és gyorsreferencia útmutatók. A papír alapú vagy nyomtatott dokumentáció egyre ritkábbá vált. A dokumentációt gyakran weboldalakon, szoftvertermékeken és egyéb online alkalmazásokon keresztül terjesztik.

A dokumentáció, mint oktatási anyagok összessége, nem tévesztendő össze a dokumentációtudománnyal, amely az információ rögzítésének és visszakeresésének tanulmányozásával foglalkozik.

A dokumentáció készítésének elvei

Bár a Nemzetközi Szabványügyi Szervezet (ISO) kapcsolódó szabványai nem könnyen elérhetők nyilvánosan, más forrásokból származó útmutatók is megfelelően szolgálhatják ezt a célt.

A dokumentáció fejlesztése magában foglalhatja a dokumentum megfogalmazását, formázását, benyújtását, felülvizsgálatát, jóváhagyását, terjesztését, újraközlését és nyomon követését, stb., és szabályozott iparágakban a kapcsolódó szabványos működési eljárás szerint zajlik. Ez magában foglalhatja a tartalom nulláról történő létrehozását is. A dokumentációnak könnyen olvashatónak és érthetőnek kell lennie. Ha túl hosszú és túl bőbeszédű, félreérthető vagy figyelmen kívül hagyható lehet. Világos, tömör szavakat kell használni, és a mondatokat legfeljebb 15 szóra kell korlátozni. Az általános közönség számára szánt dokumentációban kerülni kell a nemspecifikus kifejezéseket és a kulturális elfogultságokat. Az eljárások sorozatában a lépéseket egyértelműen számozni kell.

Dokumentáció készítése

A műszaki írók és vállalati kommunikátorok olyan szakemberek, akiknek szakterülete és munkája a dokumentáció. Ideális esetben a műszaki írók háttérrel rendelkeznek mind a témában, mind pedig az írásban, tartalomkezelésben és információs architektúrában. A műszaki írók gyakrabban működnek együtt téma szakértőkkel, mint például mérnökökkel, műszaki szakemberekkel, orvosi szakemberekkel stb., hogy meghatározzák és létrehozzák a felhasználók igényeinek megfelelő dokumentációt. A vállalati kommunikáció más típusú írásos dokumentációt is magában foglal, például:

  • Marketingkommunikáció (MarCom): A MarCom írók arra törekszenek, hogy a cég értékajánlatát különféle nyomtatott, elektronikus és közösségi médiákon keresztül közvetítsék. Ez a vállalati írás területe gyakran foglalkozik ajánlatokra való válaszadással. Műszaki kommunikáció (TechCom): A műszaki írók a cég termékét vagy szolgáltatását dokumentálják. A műszaki kiadványok tartalmazhatnak felhasználói útmutatókat, telepítési és konfigurációs kézikönyveket, valamint hibaelhárítási és javítási eljárásokat. Jogi írás: Ezt a dokumentációt gyakran ügyvédek vagy jogi asszisztensek készítik. Megfelelőségi dokumentáció: Ez a típusú dokumentáció szabványos működési eljárásokat rögzít bármely szabályozási megfelelési igényre, például biztonsági jóváhagyásra, adózásra, finanszírozásra és műszaki jóváhagyásra vonatkozóan. Egészségügyi dokumentáció: Ez a dokumentációs terület magában foglalja az egészségügyi ellátás során bekövetkezett események időben történő rögzítését és érvényesítését.[1]

Dokumentáció a számítástechnikában

Típusok

A következő tipikus szoftverdokumentációs típusok vannak:

A következő tipikus hardver- és szervizdokumentáció típusok találhatók:

Software Documentation Folder (SDF) eszköz

Egy gyakori típusú szoftverdokumentum, amelyet a szimulációs iparban írnak, az SDF. Amikor szimulátorhoz fejlesztenek szoftvert – amely kiterjedhet beágyazott avionikai eszközöktől a 3D terepadatbázisokon át a teljes mozgásvezérlő rendszerekig –, a mérnök egy jegyzetfüzetben részletezi a projekt vagy modul fejlesztését, azaz "az építést". A dokumentum lehet egy wiki oldal, Microsoft Word dokumentum vagy más környezet. Tartalmaznia kell egy követelmények szekciót és egy interfész szekciót, amely részletezi a szoftver kommunikációs interfészét. Gyakran egy jegyzetek szekciót is használnak, amelyben részletezik a koncepció bizonyítását, valamint nyomon követik a hibákat és a fejlesztéseket. Végül egy tesztelési szekciót, amely dokumentálja, hogyan tesztelték a szoftvert. Ez dokumentálja az ügyfél követelményeinek való megfelelést. Az eredmény egy részletes leírás arról, hogyan van tervezve a szoftver, hogyan kell felépíteni és telepíteni a szoftvert a céleszközre, valamint az ismert hibákat és megoldásokat. Ez az építési dokumentum lehetővé teszi a jövőbeni fejlesztők és karbantartók számára, hogy gyorsan megismerjék a szoftvert, és útmutatót nyújt a kód módosításához vagy a hibák kereséséhez.

Szoftvereszközök a hálózati leltárhoz és konfigurációhoz

Ezek a szoftveres eszközök automatikusan gyűjthetnek adatokat a hálózati eszközeiről. Az adatok lehetnek leltári és konfigurációs információk. Az Information Technology Infrastructure Library (ITIL) előírja egy ilyen adatbázis létrehozását, amely az összes információ alapjául szolgál az IT-felelősök számára. Ez az adatbázis az IT-dokumentáció alapja is. Példák erre a XIA Configuration.[2]

Dokumentáció a büntető igazságszolgáltatásban

A "dokumentáció" az előnyben részesített kifejezés a bűnügyi adatbázisok feltöltésének folyamatára. Példák erre a Nemzeti Terrorizmusellenes Központ Terrorista Identitások Adatbázisa, a szexuális bűnelkövetők nyilvántartásai és a banda adatbázisok.

Dokumentáció a kisgyermekkori nevelésben

A dokumentáció a kisgyermekkori nevelés területén az, „amikor észrevesszük és értékeljük a gyermekek ötleteit, gondolkodását, kérdéseit és elméleteit a világról, majd összegyűjtjük munkájuk nyomait (rajzok, fényképek a gyermekekről cselekvés közben, szavaik leiratai), hogy megoszthassuk a szélesebb közösséggel”.

A dokumentáció tehát egy olyan folyamat, amely a pedagógusnak a gyermekről/gyermekekről szerzett tudását és tanulását összekapcsolja a családokkal, más munkatársakkal, sőt magukkal a gyermekekkel is.

A dokumentáció a vizsgálat körforgásának szerves része - megfigyelés, reflexió, dokumentálás, megosztás és reagálás.

A pedagógiai dokumentáció a tanári dokumentációt tekintve a „gyerekek megértésében való mozgalom tanári története”.[3] Stephanie Cox Suarez szerint a "Dokumentáció – Perspektíváink átalakítása" című könyvében "a tanárokat kutatóknak tekintik, a dokumentáció pedig olyan kutatási eszköz, amely támogatja a tudásépítést gyermekek és felnőttek körében".[4]

A dokumentáció sokféle stílusban készülhet az osztályteremben. Az alábbiakban bemutatjuk azokat a módokat, amelyekkel a dokumentáció láthatóvá teheti a kutatást vagy a tanulást:

  1. Dokumentációs panelek (hirdetőtábla-szerű prezentáció több képpel és leírással a projektről vagy eseményről).
  2. Napi napló (egy minden nap vezetett napló, amely rögzíti a játékot és a tanulást az osztályteremben)
  3. A gyerekek által vagy a gyerekekkel közösen készített dokumentáció (a gyerekek dokumentálása során történő megfigyelésekor a megfigyelés gyermeklencséje kerül felhasználásra a tényleges dokumentációban)
  4. Egyéni portfóliók (az egyes gyermekek fejlődésének nyomon követésére és kiemelésére használt dokumentáció)
  5. Elektronikus dokumentáció (alkalmazások és eszközök használata a dokumentumok családokkal és munkatársaival való megosztására)
  6. Beszélgetések átirata vagy felvétele (a rögzítés a dokumentációban mélyebb reflexiókat eredményezhet mind a pedagógus, mind a gyermek számára)
  7. Tanulási történetek (egy narratíva, amelyet „a tanulás leírására használnak, és segítik a gyerekeket abban, hogy erős tanulónak tekintsék magukat”[3]
  8. Az osztályterem mint dokumentáció (egy tanterem fizikai környezetének reflexiói és dokumentálása).[3]

A dokumentáció természetesen önmagában is egy folyamat, és a pedagóguson belül is egy folyamat. A következőkben a dokumentáció fejlődését mutatjuk be, ahogyan az a pedagógus számára és magában a pedagógusban előrehalad:

  • A dokumentálási szokások kialakítása
  • Legyen kényelmes a nyilvánosság elé tárásban a tevékenységek beszámolójával
  • Fejleszti a vizuális műveltséget
  • Fogalmazzuk meg a dokumentálás célját a tanulási stílusok láthatóvá tételeként, és
  • Ossza meg látható elméletet értelmezési célokra és a tananyag további tervezésére.[5]

Jegyzetek

  1. Springhouse. Complete Guide to Documentation. Lippincott Williams & Wilkins, ix. o. (2008). ISBN 9781582555560. Hozzáférés ideje: 2009. június 12. 
  2. XIA Configuration Network Documentation Tool. CENTREL Solutions. (Hozzáférés: 2017. augusztus 8.)
  3. a b c Susan, Stacey. Pedagogical documentation in early childhood : sharing children's learning and teachers' thinking (2015. május 11.). ISBN 9781605543925. OCLC 909907917 
  4. Rivard: Documentation: Transforming our Perspectives | Project Zero (angol nyelven). www.pz.harvard.edu. (Hozzáférés: 2018. október 26.)
  5. ECRP. Vol 13 No 2. ecrp.uiuc.edu. [2018. október 27-i dátummal az eredetiből archiválva]. (Hozzáférés: 2018. október 26.)

Fordítás

Ez a szócikk részben vagy egészben a Documentation című angol Wikipédia-szócikk ezen változatának fordításán alapul. Az eredeti cikk szerkesztőit annak laptörténete sorolja fel. Ez a jelzés csupán a megfogalmazás eredetét és a szerzői jogokat jelzi, nem szolgál a cikkben szereplő információk forrásmegjelöléseként.

Read other articles:

Nigel Pearson Pearson di tempat latihan Leicester Citypada tahun 2013Informasi pribadiNama lengkap Nigel Graham Pearson[1]Tanggal lahir 21 Agustus 1963 (umur 60)Tempat lahir Nottingham, InggrisTinggi 1,85 m (6 ft 1 in)Posisi bermain BekKarier junior1980–1981 Heanor TownKarier senior*Tahun Tim Tampil (Gol)1981–1987 Shrewsbury Town 153 (5)1987–1994 Sheffield Wednesday 180 (14)1994–1998 Middlesbrough 116 (5)Total 449 (24)Kepelatihan1998–1999 Carlisle United...

 

 

Selimut HatiGenre Drama Roman PembuatMD EntertainmentPemeran Primus Yustisio Catherine Wilson Ardina Rasti Ade Irawan Penggubah lagu temaAhmad DhaniLagu pembukaSelimut Hati oleh Dewa 19Lagu penutupSelimut Hati oleh Dewa 19Negara asalIndonesiaBahasa asliBahasa IndonesiaJmlh. musim1Jmlh. episode6 (daftar episode)ProduksiProduser Dhamoo Punjabi Manoj Punjabi Pengaturan kameraHeru S NingratDurasi60 menitRumah produksiMD EntertainmentDistributorMedia Nusantara CitraRilis asliJaringanRCTIRilis2 Ag...

 

 

Massively multiplayer online role-playing game This article needs additional citations for verification. Please help improve this article by adding citations to reliable sources. Unsourced material may be challenged and removed.Find sources: Star Trek Online – news · newspapers · books · scholar · JSTOR (December 2021) (Learn how and when to remove this template message) 2010 video gameStar Trek OnlineCover art for Star Trek OnlineDeveloper(s)Cryptic S...

Railway line in the UK Not to be confused with the heritage East Lancashire Railway or the historical East Lancashire Railway (1844–1859). East Lancashire lineA Northern Rail Class 142 at ColneOverviewOwnerNetwork RailLocaleLancashireBlackburnBurnleyPendleNorth West EnglandTerminiPrestonColneServiceSystemNational RailOperator(s)NorthernHistoryOpened1849TechnicalNumber of tracksMainly Double Track, with Single Track from Burnley Barracks to ColneTrack gauge1,435 mm (4 ft 8+1&#...

 

 

For the Revolutionary War unit, see 2nd South Carolina Regiment. This article includes a list of references, related reading, or external links, but its sources remain unclear because it lacks inline citations. Please help improve this article by introducing more precise citations. (September 2017) (Learn how and when to remove this template message) 2nd South Carolina Infantry Regiment2nd Palmetto RegimentFlag of South CarolinaActiveApril 9, 1861 to April 26th, 1865CountryConfederate States ...

 

 

Aycomune Ay – Veduta LocalizzazioneStato Francia RegioneGrand Est Dipartimento Marna ArrondissementÉpernay CantoneÉpernay-1 TerritorioCoordinate49°03′N 4°00′E / 49.05°N 4°E49.05; 4 (Ay)Coordinate: 49°03′N 4°00′E / 49.05°N 4°E49.05; 4 (Ay) Altitudine76 m s.l.m. Superficie10,43 km² Abitanti4 172[1] (2009) Densità400 ab./km² Altre informazioniCod. postale51160 e 51150 Fuso orarioUTC+1 Codice INSEE510...

Brazilian film and television director and screenwriter Jorge FurtadoFurtado in November 2010Born (1959-06-09) June 9, 1959 (age 64)Porto Alegre, Rio Grande do Sul, BrazilOccupation(s)Screenwriter, director Jorge Alberto Furtado (born June 9, 1959) is a Brazilian film and television director and screenwriter. Life and career Furtado attended university for courses in medicine, psychology, journalism and arts, but did not graduate. He began his professional career in the 1980s on a local ...

 

 

У этого термина существуют и другие значения, см. Мюнхен (значения). ГородМюнхеннем. München[1] Флаг Герб[d] 48°08′15″ с. ш. 11°34′30″ в. д.HGЯO Страна  Германия Статус административный центр земли административный центр округа внерайонный город Земля Бавария �...

 

 

此條目可参照英語維基百科相應條目来扩充。 (2021年5月6日)若您熟悉来源语言和主题,请协助参考外语维基百科扩充条目。请勿直接提交机械翻译,也不要翻译不可靠、低品质内容。依版权协议,译文需在编辑摘要注明来源,或于讨论页顶部标记{{Translated page}}标签。 约翰斯顿环礁Kalama Atoll 美國本土外小島嶼 Johnston Atoll 旗幟颂歌:《星條旗》The Star-Spangled Banner約翰斯頓環礁�...

坐标:43°11′38″N 71°34′21″W / 43.1938516°N 71.5723953°W / 43.1938516; -71.5723953 此條目需要补充更多来源。 (2017年5月21日)请协助補充多方面可靠来源以改善这篇条目,无法查证的内容可能會因為异议提出而被移除。致使用者:请搜索一下条目的标题(来源搜索:新罕布什尔州 — 网页、新闻、书籍、学术、图像),以检查网络上是否存在该主题的更多可靠来源...

 

 

ヨハネス12世 第130代 ローマ教皇 教皇就任 955年12月16日教皇離任 964年5月14日先代 アガペトゥス2世次代 レオ8世個人情報出生 937年スポレート公国(中部イタリア)スポレート死去 964年5月14日 教皇領、ローマ原国籍 スポレート公国親 父アルベリーコ2世(スポレート公)、母アルダその他のヨハネステンプレートを表示 ヨハネス12世(Ioannes XII、937年 - 964年5月14日)は、ロ...

 

 

Частина серії проФілософіяLeft to right: Plato, Kant, Nietzsche, Buddha, Confucius, AverroesПлатонКантНіцшеБуддаКонфуційАверроес Філософи Епістемологи Естетики Етики Логіки Метафізики Соціально-політичні філософи Традиції Аналітична Арістотелівська Африканська Близькосхідна іранська Буддій�...

Railway station in England Whitecroft & BreamStation on heritage railwayGeneral informationLocationWhitecroft, Forest of DeanEnglandCoordinates51°45′10″N 2°33′09″W / 51.75290°N 2.55247°W / 51.75290; -2.55247Grid referenceSO619062Managed byDean Forest RailwayPlatforms1HistoryOriginal companySevern and Wye RailwayKey dates23 September 1875opened8 July 1929closed for passengers25 May 2012reopened Whitecroft & Bream railway station is a railway station ...

 

 

Part of a series onAmerican cuisine Regional cuisines Northeastern New England New Jersey New York City Philadelphia Midwestern Chicago Michigan North Dakota Ohio Omaha St. Louis Wisconsin Mid-Atlantic Baltimore Pittsburgh Southern (list) Atlanta Cajun Floribbean Kentucky Louisiana Creole Lowcountry Houston New Orleans Texas Tex-Mex Western California California fusion Los Angeles Pacific Northwest Rocky Mountain Southwestern New Mexican Other Hawaiian Military rations Puerto Rican Roadkill ...

 

 

Artikel ini sebatang kara, artinya tidak ada artikel lain yang memiliki pranala balik ke halaman ini.Bantulah menambah pranala ke artikel ini dari artikel yang berhubungan atau coba peralatan pencari pranala.Tag ini diberikan pada November 2022. Betty BoydLahirElizabeth Boyd Smith(1908-05-11)11 Mei 1908Kansas City, Missouri, A.S.Meninggal16 September 1971(1971-09-16) (umur 63)Los Angeles, California, A.S.PekerjaanAktrisTahun aktif1927-1949Suami/istriRich Broker (?-1934)Charles N. Ov...

Historic house in New Canaan, Connecticut This article is about the Philip Johnson house. For other uses, see Glass house (disambiguation). Glass HouseInteractive map showing the house's locationLocation798–856 Ponus Ridge Road, New Canaan, ConnecticutCoordinates41°8′32.73″N 73°31′45.84″W / 41.1424250°N 73.5294000°W / 41.1424250; -73.5294000Public transit access New CanaanWebsitetheglasshouse.org Philip Johnson Glass HouseU.S. National Register of Histori...

 

 

Om Prakash KohliKohli pada 2016 Gubernur Gujarat ke-19Masa jabatan16 Juli 2014 – 15 Juli 2019Kepala MenteriAnandiben PatelVijay RupaniPendahuluMargaret AlvaPenggantiAcharya Dev VratGubernur Madhya PradeshMasa jabatan8 September 2016 – 19 Januari 2018Kepala MenteriShivraj Singh ChauhanPendahuluRam Naresh YadavPenggantiAnandiben PatelGubernur GoaMasa jabatan6 August 2014 – 25 August 2014Kepala MenteriManohar ParrikarPendahuluMargaret AlvaPenggantiMridula Sin...

 

 

Disambiguazione – Se stai cercando l'omonimo calciatore nato nel 1911, vedi Giordano Colaussi. Questa voce sull'argomento calciatori italiani è solo un abbozzo. Contribuisci a migliorarla secondo le convenzioni di Wikipedia. Segui i suggerimenti del progetto di riferimento. Giordano ColausigColausig al Perugia nella stagione 1972-1973Nazionalità Italia Altezza172[1] cm Peso64[1] kg Calcio RuoloCentrocampista, attaccante Termine carriera1974 CarrieraSquadre di cl...

この項目では、天体現象について説明しています。その他の用法については「超新星 (曖昧さ回避)」をご覧ください。 この記事は検証可能な参考文献や出典が全く示されていないか、不十分です。 出典を追加して記事の信頼性向上にご協力ください。(このテンプレートの使い方)出典検索?: 超新星 – ニュース · 書籍 · スカラー · CiNii · J...

 

 

Большая печать штата Невада Детали Утверждена 1862 Большая печать штата Невада — один из государственных символов штата Невада, США. 31 октября 1864 года президентом Авраамом Линкольном Невада была провозглашена штатом. 24 февраля 1866 года был принят новый девиз штата: «All fo...