Jde E1 9.2 Documentation
Arlyne Doepner
Documentation 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.[1] As a form of knowledge management and knowledge organization, documentation can be provided on paper, online, or on digital or analog media, such as audio tape or CDs. Examples are user guides, white papers, online help, and quick-reference guides. Paper or hard-copy documentation has become less common.[citation needed] Documentation is often distributed via websites, software products, and other online applications.
Documentation development may involve document drafting, formatting, submitting, reviewing, approving, distributing, reposting and tracking, etc., and are convened by associated standard operating procedure 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. Documentation intended for a general audience should avoid gender-specific terms and cultural biases. In a series of procedures, steps should be clearly numbered.[6][7][8][9]
Technical writers 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 information architecture. Technical writers more commonly collaborate with subject-matter experts, such as engineers, technical experts, medical professionals, etc. to define and then create documentation to meet the user's needs. Corporate communications includes other types of written documentation, for example:
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" of the project or module. The document can be a wiki page, Microsoft Word document or other environment. They should contain a requirements section, an interface section to detail the communication interface of the software. Often a notes section is used to detail the proof of concept, and then track errors and enhancements. Finally, a testing 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 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.
These software tools can automatically collect data of your network equipment. The data could be for inventory and for configuration information. The Information Technology Infrastructure Library 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.[11]
"Documentation" is the preferred term for the process of populating criminal databases. Examples include the National Counterterrorism Center's Terrorist Identities Datamart Environment, sex offender registries, and gang databases.[12]
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 a wider community".[13]
Pedagogical documentation, in terms of the teacher documentation, is the "teacher's story of the movement in children's understanding".[13] According to Stephanie Cox Suarez in "Documentation - Transforming our Perspectives", "teachers are considered researchers, and documentation is a research tool to support knowledge building among children and adults".[14]
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:
Welcome to the Project Jupyter documentation site. Jupyter is a large umbrellaproject that covers many different software offerings and tools, including thepopular Jupyter Notebookand JupyterLab web-basednotebook authoring and editing applications. The Jupyter project and itssubprojects all center around providing tools (and standards)for interactive computing with computational notebooks.
A notebook is a shareable document that combines computer code, plain languagedescriptions, data, rich visualizations like 3D models, charts, graphs andfigures, and interactive controls. A notebook, along with an editor (likeJupyterLab), provides a fast interactive environment for prototyping andexplaining code, exploring and visualizing data, and sharing ideas withothers.
Individual sub-projects are typically organized around a key feature of theJupyter ecosystem, and have their own community, documentation and governance.Below is a list of documentation for major parts of the Jupyter ecosystem.
If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.
Descriptive how-to content with both high-level introductions and step-by-step workflows for using Firebase products. Find Firebase guides under the Fundamentals, Build and and Run tabs at the top of the page.
Guided tutorials with hands-on coding to develop practical experience and build working code and apps. Start a Firebase codelab for iOS, Android, or Web. wysiwyg Reference documentation Formal reference documentation for Firebase SDKs, Firebase REST APIs, and Firebase tools. Find Firebase reference docs under the Reference tab at the top of the page.
Infinite Scale is a cloud-native microservices-based architecture and the latest generation of server applications. It does not depend on external software packages like PHP or a database which eliminates all the hassle that comes along with using them. With its modern architecture, Infinite Scale provides all deployment models for cloud infrastructure deployments and optimized scaling setups for the best output in return for the invested energy. With the single binary concept, managing the server is much more streamlined over all deployment methods.
ownCloud Web is bundled with Infinite Scale, has a new design and comes with a brand-new look. The goal is to make ownCloud accessible to all people from children to experts. Technically, ownCloud Web is built with VueJS as a dedicated client, communicating via well-formed APIs with the Infinite Scale server, just like all the other ownCloud clients. ownCloud Web can be used as an app for ownCloud Server but is limited in its capabilities. Nevertheless, switching to ownCloud Web makes a future migration to Infinite Scale easier for users as they are already used to the new UI. ownCloud Web can be customized according to your corporate identity via config values. For details see the Web UI configuration documentation.
Infinite Scale comes with a ramped-up WOPI protocol server that provides collaborative office document editing with multiple users. It supports Microsoft Online Office 365, Collabora Office and OnlyOffice out of the box and is ready to support more collaborative editors in the near future. With the focus on seamless collaboration, files are locked when opened in an online editor to show others that they are in use and likely to change.
In Infinite Scale, we drastically simplified sharing by links. First of all: You can get a link with a single click in ownCloud Web. Second: You can share one and the same link with internal and external people at once, and if you change your mind, you can restrict access, for example, to only internal people of your organization. This feature was known as "private link" in ownCloud 10 and is still available but via the "internal" selection of a link.
Infinite Scale is a platform built of independent microservices that communicate over the highly efficient gRPC protocol internally and provide HTTP APIs externally. That gives the flexibility for easy extension, integration and deployment of the entire platform.
One of the biggest benefits of Infinite Scale is the variety of deployment models that make the rollout of the platform really easy and independent of the underlying infrastructure as much as possible.
Infinite Scale can be delivered as a single binary - which is a self-contained, complete and ready to start compilation of all microservices that are needed to simply start Infinite Scale. Other featured deployment methods are docker images and docker-compose files. For setups with scaling requirements all Infinite Scale microservices can be deployed and scaled separately on orchestration infrastructure like Kubernetes.
ownCloud Server is an open source LAMP-stack-based server application that allows you to access your files from anywhere in a secure way. The files are stored on a server running ownCloud. You can access your files via the browser or sync them to your desktop or mobile device like you might know it from oneDrive, Dropbox or others. The difference with ownCloud is that you stay in control of your data as you can install ownCloud in your own environment.
The web interfaces integrated in ownCloud Infinite Scale and owncloud Server give users native access to their ownCloud cloud data. With no need for user-side installations, one can just access their data securely from all over the world with just a browser.
c80f0f1006