NALAdocs add a whole new dimension to the way you can
provide your knowledge and expertise to programmers.
As the technical author or maintainer of a library, framework, or web API, you produce the documentation that developers rely on to understand and verify their hand-written and AI-generated code.
But there’s a big gap between you providing that information and programmers applying it to their code in order to understand it. It is an error-prone and time consuming task that greatly reduces the productivity gains of AI-generated code.
NALAdocs redress those productivity losses. They are a new form of programming documentation that bring your knowledge into code editors and automatically apply it to the code to explain its meaning and behavior including any coding errors and security vulnerabilities.
It's as if you were there in person explaining their code!
Share your knowledge with programmers by
automatically explaining their code.
It’s a game changer!
How NALAdocs Benefit Authors
Promote
Share your knowledge and
expertise, and increase your
standing in the community
Earn
Make money authoring
NALAdocs in less time than
conventional documentation
Cross-Sell
Add links to your eBooks,
online tutorials, training
and consulting services
You explain the programming concepts.
Our AI inference engine tailors
your explanations to the code.
Producing conventional documentation and tutorials is a huge undertaking that can take up a lot of your time and effort over many months.
Creating NALAdocs is easier and quicker because you write a lot less; you don’t need to worry about how best to introduce and organize the concepts you aim to cover; nor write, test and explain example code.
It’s a simple process: We use our knowledge harvesters to capture the definitions of the programming concepts in the domain you want to write about, and you explain them individually using templates that reference their properties.
The topics you explain we call Concepts - JavaScript objects with properties. They are our basic unit of knowledge representation.
The NALAdocs Reader models every statement and expression in the source code as a Concept. Its properties are populated with data from the code or point to other Concepts from the same or related knowledge domains.
We provide you with the Concept definitions for the knowledge domain you want to document, and you explain each concept individually. At runtime, the NALAdocs Reader dynamically assembles those explanations from the same or related domains.
Explanations are
dynamically assembled
Add warnings about API misuses,
security vulnerabilities,
and good practice violations.
The NALAdocs Writer is the editor you use to create NALAdocs. It is included with some or our commercial editions of the NALAdocs Reader.
For each Concept you write a summary explanation of what it is or does, and optionally a detailed explanation describing how it does it. You can also include other background information and links to online documentation for the library, framework or web API you are writing about.
Your explanations are written as plain text and may include references to the Concept’s properties to dynamically contextualized your explanations to the code at runtime.
For each Concept you should also include warnings of possible coding errors and security issues, which are conditionally displayed at runtime in the correct context.
If you’ve written related books and tutorials, or provide training or other services, you can also include links to them. It’s an excellent way to promote and cross-sell what you have to offer.
Help Us Grow the NALAdocs Library
We are focusing on providing NALAdocs for the JavaScript ecosystem and the Web. That covers a range of knowledge domains, from HTML, CSS, JavaScript and TypeScript to popular libraries and frameworks, NodeJS modules, SQL and non-SQL data stores, and web APIs.
If you have knowledge of any of these domains, join our community of authors. We’ll negotiate with you a fair remuneration that could range from paying you outright for your work, to an entirely royalty-based deal.
We'll contact you to provide more information and discuss the domain(s) you would like to write about.