Knowledge

Documentation

Source 📝

279:
A common type of software document written in the simulation industry is the SDF. When developing software for a simulator, which can range from embedded avionics devices to 3D terrain databases by way of full motion control systems, the engineer keeps a notebook detailing the development "the build"
337:
Documentation, as it pertains to the early childhood education field, is "when we notice and value children's ideas, thinking, questions, and theories about the world and then collect traces of their work (drawings, photographs of the children in action, and transcripts of their words) to share with
347:
Pedagogical documentation, in terms of the teacher documentation, is the "teacher's story of the movement in children's understanding". According to Stephanie Cox Suarez in "Documentation - Transforming our Perspectives", "teachers are considered researchers, and documentation is a research tool to
296:
section to document how the software was tested. This documents conformance to the client's requirements. The result is a detailed description of how the software is designed, how to build and install the software on the target device, and any known defects and workarounds. This build document
94:
in a regulatory industry. It could also involve creating content from scratch. Documentation should be easy to read and understand. If it is too long and too wordy, it may be misunderstood or ignored. Clear, concise words should be used, and sentences should be limited to a maximum of 15 words.
31:
is any communicable material that is used to describe, explain or instruct regarding some attributes of an object, system or procedure, such as its parts, assembly, installation, maintenance, and use. As a form of
125:(MarCom): MarCom writers endeavor to convey the company's value proposition through a variety of print, electronic, and social media. This area of corporate writing is often engaged in responding to proposals. 380:
Documentation is certainly a process in and of itself, and it is also a process within the educator. The following is the development of documentation as it progresses for and in the educator themselves:
131:(TechCom): Technical writers document a company's product or service. Technical publications can include user guides, installation and configuration manuals, and troubleshooting and repair procedures. 106:
and corporate communicators are professionals whose field and work is documentation. Ideally, technical writers have a background in both the subject matter and also in writing, managing content, and
140:
Compliance documentation: This type of documentation codifies standard operating procedures, for any regulatory compliance needs, as for safety approval, taxation, financing, and technical approval.
68:, and quick-reference guides. Paper or hard-copy documentation has become less common. Documentation is often distributed via websites, software products, and other online applications. 341:
Thus, documentation is a process, used to link the educator's knowledge and learning of the child/children with the families, other collaborators, and even to the children themselves.
744: 90:
Documentation development may involve document drafting, formatting, submitting, reviewing, approving, distributing, reposting and tracking, etc., and are convened by associated
143:
Healthcare documentation: This field of documentation encompasses the timely recording and validation of events that have occurred during the course of providing health care.
309:
requests to create such a database as a basis for all information for the IT responsible. It is also the basis for IT documentation. Examples include XIA Configuration.
361:
Documentation developed by or with the children (when observing children during documentation, the child's lens of the observation is used in the actual documentation)
297:
enables future developers and maintainers to come up to speed on the software in a timely manner, and also provides a roadmap to modifying code or searching for bugs.
854: 351:
Documentation can take many different styles in the classroom. The following exemplifies ways in which documentation can make the research, or learning, visible:
95:
Documentation intended for a general audience should avoid gender-specific terms and cultural biases. In a series of procedures, steps should be clearly numbered.
122: 781: 817: 671: 305:
These software tools can automatically collect data of your network equipment. The data could be for inventory and for configuration information. The
370:
Transcripts or recordings of conversations (using recording in documentation can bring about deeper reflections for both the educator and the child)
533: 508: 503: 498: 488: 1037: 493: 84: 755: 114:, such as engineers, technical experts, medical professionals, etc. to define and then create documentation to meet the user's needs. 322: 707: 642: 1117: 280:
of the project or module. The document can be a wiki page, Microsoft Word document or other environment. They should contain a
355:
Documentation panels (bulletin-board-like presentation with multiple pictures and descriptions about the project or event).
916: 865: 344:
Documentation is an integral part of the cycle of inquiry - observing, reflecting, documenting, sharing and responding.
1013: 926: 792: 318: 87:(ISO) standards are not easily available publicly, a guide from other sources for this topic may serve the purpose. 1136: 1077: 1052: 373:
Learning stories (a narrative used to "describe learning and help children see themselves as powerful learners")
828: 317:"Documentation" is the preferred term for the process of populating criminal databases. Examples include the 682: 1141: 91: 891: 376:
The classroom as documentation (reflections and documentation of the physical environment of a classroom).
367:
Electronic documentation (using apps and devices to share documentation with families and collaborators)
458: 1005:
Pedagogical documentation in early childhood : sharing children's learning and teachers' thinking
974:
Rader Brown, Rebecca (2009). "The Gang's All Here: Evaluating the Need for a National Gang Database".
453: 538: 292:
section is used to detail the proof of concept, and then track errors and enhancements. Finally, a
263: 231: 195: 186: 107: 593: 558: 326: 216: 128: 115: 583: 468: 364:
Individual portfolios (documentation used to track and highlight the development of each child)
245: 153: 111: 37: 20: 448: 443: 413: 72: 167: 33: 8: 568: 478: 1031: 718: 578: 483: 397:
Share(s) visible theories for interpretation purposes and further design of curriculum.
249: 949: 653: 1019: 1009: 922: 553: 200: 176: 103: 1116:
Library of articles on documentation: Technical writing and documentation articles]
394:
Conceptualize(s) the purpose of documentation as making learning styles visible, and
358:
Daily log (a log kept every day that records the play and learning in the classroom)
463: 208: 1121: 1003: 259: 236: 211: 182: 418: 191: 1130: 1023: 134: 71:
Documentation as a set of instructional materials shouldn't be confused with
49: 41: 61: 53: 45: 1110: 617: 137:: This type of documentation is often prepared by attorneys or paralegals. 588: 433: 300: 172: 65: 1085: 288:
section to detail the communication interface of the software. Often a
573: 563: 548: 57: 818:"GLNPO's Quality System Documentation Review Procedures and Tracking" 543: 528: 428: 388:
Become(s) comfortable with going public with recounting of activities
241: 227:
The following are typical hardware and service documentation types:
892:"Data Services Process Guides: Documentation Processing Techniques" 855:"Data Services Process Guides: Documentation Processing Procedures" 523: 518: 473: 438: 423: 221: 19:
For a guide on using the documentation in Knowledge templates, see
513: 408: 253: 1053:"Documentation: Transforming our Perspectives | Project Zero" 332: 204: 118:
includes other types of written documentation, for example:
618:"Documentation definition by The Linux Information Project" 306: 274: 267: 75:, the study of the recording and retrieval of information. 78: 163:
The following are typical software documentation types:
40:, documentation can be provided on paper, online, or on 16:
Set of documents providing knowledge to explain a system
348:
support knowledge building among children and adults".
301:
Software tools for network inventory and configuration
312: 147: 110:. Technical writers more commonly collaborate with 921:. Lippincott Williams & Wilkins. p. ix. 1128: 534:International Standard Bibliographic Description 852: 950:"XIA Configuration Network Documentation Tool" 779: 85:International Organization for Standardization 307:Information Technology Infrastructure Library 268:Information Technology Infrastructure Library 976:Columbia Journal of Law and Social Problems 973: 914: 889: 1036:: CS1 maint: location missing publisher ( 333:Documentation in early childhood education 98: 323:Terrorist Identities Datamart Environment 1113:by The Linux Information Project (LINFO) 275:Software Documentation Folder (SDF) tool 1129: 79:Principles for producing documentation 1001: 997: 995: 993: 991: 989: 780:Cropper, Mark; Dibbens, Tony (2002). 908: 883: 825:U.S. Environmental Protection Agency 846: 810: 782:"GAIA-RVS Documentation Procedures" 773: 700: 663: 13: 1070: 1050: 1044: 986: 742: 736: 635: 385:Develop(s) habits of documentation 14: 1153: 1104: 672:"A Guide to Documentation Styles" 391:Develop(s) visual literacy skills 313:Documentation in criminal justice 148:Documentation in computer science 669: 319:National Counterterrorism Center 967: 942: 918:Complete Guide to Documentation 745:"Procedures and Documentation" 708:"A guide to MLA documentation" 679:San Francisco State University 610: 1: 1002:Susan, Stacey (11 May 2015). 603: 92:standard operating procedure 7: 401: 10: 1158: 459:Document management system 151: 18: 196:functional specifications 1111:Documentation Definition 853:UK Data Archive (2009). 643:"Guide to Documentation" 539:Journal of Documentation 187:functional specification 158: 116:Corporate communications 108:information architecture 1137:Technical communication 1008:. St. Paul, Minnesota. 594:Technical communication 559:Technical documentation 327:sex offender registries 217:User acceptance testing 129:Technical communication 99:Producing documentation 652:. 2003. Archived from 584:Software documentation 469:Freedom of information 329:, and gang databases. 154:Software documentation 112:subject-matter experts 38:knowledge organization 21:Template:Documentation 1120:18 April 2010 at the 449:Documentation science 444:Documentation (field) 414:Bibliographic control 123:Market communications 73:documentation science 915:Springhouse (2008). 338:a wider community". 168:Request for proposal 34:knowledge management 1142:Information science 1078:"ECRP. Vol 13 No 2" 724:on 2 September 2006 569:Medical certificate 479:Historical document 454:Document identifier 1088:on 27 October 2018 1057:www.pz.harvard.edu 834:on 4 December 2008 798:on 2 November 2005 579:Records management 484:Index (publishing) 1051:Rivard, Melissa. 954:CENTREL Solutions 890:UK Data Archive. 752:maintenanceonline 688:on 5 January 2011 264:service portfolio 201:Change management 177:statement of work 104:Technical writers 83:While associated 1149: 1098: 1097: 1095: 1093: 1084:. Archived from 1074: 1068: 1067: 1065: 1063: 1048: 1042: 1041: 1035: 1027: 999: 984: 983: 971: 965: 964: 962: 960: 946: 940: 939: 937: 935: 912: 906: 905: 903: 901: 896: 887: 881: 880: 878: 876: 870: 864:. Archived from 859: 850: 844: 843: 841: 839: 833: 827:. Archived from 822: 814: 808: 807: 805: 803: 797: 791:. Archived from 786: 777: 771: 770: 768: 766: 760: 754:. Archived from 749: 740: 734: 733: 731: 729: 723: 717:. Archived from 712: 704: 698: 697: 695: 693: 687: 681:. Archived from 676: 667: 661: 660: 659:on 29 July 2007. 658: 650:somers.k12.ct.us 647: 639: 633: 632: 630: 628: 614: 554:List of Contents 232:Network diagrams 1157: 1156: 1152: 1151: 1150: 1148: 1147: 1146: 1127: 1126: 1122:Wayback Machine 1107: 1102: 1101: 1091: 1089: 1076: 1075: 1071: 1061: 1059: 1049: 1045: 1029: 1028: 1016: 1000: 987: 972: 968: 958: 956: 948: 947: 943: 933: 931: 929: 913: 909: 899: 897: 894: 888: 884: 874: 872: 871:on 13 June 2010 868: 857: 851: 847: 837: 835: 831: 820: 816: 815: 811: 801: 799: 795: 784: 778: 774: 764: 762: 761:on 27 July 2011 758: 747: 743:Berger, David. 741: 737: 727: 725: 721: 710: 706: 705: 701: 691: 689: 685: 674: 668: 664: 656: 645: 641: 640: 636: 626: 624: 616: 615: 611: 606: 600: 598: 404: 335: 315: 303: 277: 260:Service catalog 183:Software design 161: 156: 150: 101: 81: 56:. Examples are 24: 17: 12: 11: 5: 1155: 1145: 1144: 1139: 1125: 1124: 1114: 1106: 1105:External links 1103: 1100: 1099: 1069: 1043: 1014: 985: 966: 941: 927: 907: 882: 845: 809: 789:mssl.ucl.ac.uk 772: 735: 699: 662: 634: 608: 607: 605: 602: 597: 596: 591: 586: 581: 576: 571: 566: 561: 556: 551: 546: 541: 536: 531: 526: 521: 516: 511: 506: 501: 496: 491: 486: 481: 476: 471: 466: 461: 456: 451: 446: 441: 436: 431: 426: 424:Citation Index 421: 419:Change control 416: 411: 405: 403: 400: 399: 398: 395: 392: 389: 386: 378: 377: 374: 371: 368: 365: 362: 359: 356: 334: 331: 314: 311: 302: 299: 276: 273: 272: 271: 257: 239: 234: 225: 224: 219: 214: 198: 189: 180: 179:/scope of work 170: 160: 157: 152:Main article: 149: 146: 145: 144: 141: 138: 132: 126: 100: 97: 80: 77: 15: 9: 6: 4: 3: 2: 1154: 1143: 1140: 1138: 1135: 1134: 1132: 1123: 1119: 1115: 1112: 1109: 1108: 1087: 1083: 1082:ecrp.uiuc.edu 1079: 1073: 1058: 1054: 1047: 1039: 1033: 1025: 1021: 1017: 1015:9781605543925 1011: 1007: 1006: 998: 996: 994: 992: 990: 981: 977: 970: 955: 951: 945: 930: 928:9781582555560 924: 920: 919: 911: 893: 886: 867: 863: 856: 849: 830: 826: 819: 813: 794: 790: 783: 776: 757: 753: 746: 739: 720: 716: 709: 703: 684: 680: 673: 666: 655: 651: 644: 638: 623: 622:www.linfo.org 619: 613: 609: 601: 595: 592: 590: 587: 585: 582: 580: 577: 575: 572: 570: 567: 565: 562: 560: 557: 555: 552: 550: 547: 545: 542: 540: 537: 535: 532: 530: 527: 525: 522: 520: 517: 515: 512: 510: 509:ISO 6357:1985 507: 505: 504:ISO 3602:1989 502: 500: 499:ISO 5123:1984 497: 495: 492: 490: 489:ISO 2384:1977 487: 485: 482: 480: 477: 475: 472: 470: 467: 465: 462: 460: 457: 455: 452: 450: 447: 445: 442: 440: 437: 435: 432: 430: 427: 425: 422: 420: 417: 415: 412: 410: 407: 406: 396: 393: 390: 387: 384: 383: 382: 375: 372: 369: 366: 363: 360: 357: 354: 353: 352: 349: 345: 342: 339: 330: 328: 324: 320: 310: 308: 298: 295: 291: 287: 283: 269: 265: 261: 258: 255: 251: 247: 243: 240: 238: 235: 233: 230: 229: 228: 223: 220: 218: 215: 213: 210: 206: 202: 199: 197: 193: 192:System design 190: 188: 184: 181: 178: 174: 171: 169: 166: 165: 164: 155: 142: 139: 136: 135:Legal writing 133: 130: 127: 124: 121: 120: 119: 117: 113: 109: 105: 96: 93: 88: 86: 76: 74: 69: 67: 63: 59: 55: 51: 47: 43: 39: 35: 30: 29:Documentation 26: 22: 1090:. Retrieved 1086:the original 1081: 1072: 1060:. Retrieved 1056: 1046: 1004: 979: 975: 969: 957:. Retrieved 953: 944: 932:. Retrieved 917: 910: 898:. Retrieved 885: 873:. Retrieved 866:the original 861: 848: 836:. Retrieved 829:the original 824: 812: 800:. Retrieved 793:the original 788: 775: 763:. Retrieved 756:the original 751: 738: 726:. Retrieved 719:the original 714: 702: 690:. Retrieved 683:the original 678: 665: 654:the original 649: 637: 625:. Retrieved 621: 612: 599: 494:ISO 259:1984 379: 350: 346: 343: 340: 336: 316: 304: 293: 289: 285: 284:section, an 282:requirements 281: 278: 237:Network maps 226: 173:Requirements 162: 102: 89: 82: 70: 62:white papers 46:analog media 28: 27: 25: 589:Style guide 464:Documentary 434:Description 209:enhancement 66:online help 58:user guides 1131:Categories 1092:26 October 1062:26 October 982:: 293–333. 862:esds.ac.uk 604:References 574:Publishing 564:User guide 549:Letterhead 246:IT systems 50:audio tape 48:, such as 1032:cite book 1024:909907917 544:Licensing 529:IEC 61355 429:Copyright 409:Authoring 286:interface 242:Datasheet 1118:Archived 959:8 August 627:9 August 524:ISO 9001 519:ISO 5964 474:Glossary 439:Document 402:See also 222:Manpages 212:tracking 934:12 June 900:15 June 875:15 June 838:15 June 802:15 June 765:15 June 728:12 June 715:sunyjcc 692:12 June 514:ISO 690 294:testing 256:, e.g.) 42:digital 1022:  1012:  925:  670:CGRP. 254:switch 250:server 895:(PDF) 869:(PDF) 858:(PDF) 832:(PDF) 821:(PDF) 796:(PDF) 785:(PDF) 759:(PDF) 748:(PDF) 722:(PDF) 711:(PDF) 686:(PDF) 675:(PDF) 657:(PDF) 646:(PDF) 290:notes 205:error 159:Types 1094:2018 1064:2018 1038:link 1020:OCLC 1010:ISBN 961:2017 936:2009 923:ISBN 902:2009 877:2009 840:2009 804:2009 767:2009 730:2009 694:2009 629:2020 262:and 244:for 207:and 194:and 185:and 36:and 321:'s 54:CDs 52:or 44:or 1133:: 1080:. 1055:. 1034:}} 1030:{{ 1018:. 988:^ 980:42 978:. 952:. 860:. 823:. 787:. 750:. 713:. 677:. 648:. 620:. 325:, 252:, 203:, 64:, 60:, 1096:. 1066:. 1040:) 1026:. 963:. 938:. 904:. 879:. 842:. 806:. 769:. 732:. 696:. 631:. 270:) 266:( 248:( 175:/ 23:.

Index

Template:Documentation
knowledge management
knowledge organization
digital
analog media
audio tape
CDs
user guides
white papers
online help
documentation science
International Organization for Standardization
standard operating procedure
Technical writers
information architecture
subject-matter experts
Corporate communications
Market communications
Technical communication
Legal writing
Software documentation
Request for proposal
Requirements
statement of work
Software design
functional specification
System design
functional specifications
Change management
error

Text is available under the Creative Commons Attribution-ShareAlike License. Additional terms may apply.