Finally, let's talk about methods. In your documentation hierarchy, a specific class contains its methods, with each method listed as a sibling to the other methods under that class. This structured organization helps illustrate the relationship between the class and its methods, making it easier for users to understand how to interact with the functionality … Continue reading Documenting Methods
Tag: java
Documenting Objects
Let's talk about Objects. I mention objects after classes to account for the content structure of the documentation. Information for instantiating a class (Object) is contained on the class purpose page, or a child page nested beneath it. While documentation may not explicitly list every individual object, the context of the class documentation provides the … Continue reading Documenting Objects
Documenting Classes
Classes serve as blueprints that define the structure (attributes) and behaviors (methods) of objects, which are instances of those classes. When documenting classes, you are essentially detailing the blueprint for creating, utilizing, and deploying the class effectively. This blueprint can come together on a unique page that captures the following: High-level Overview - At the … Continue reading Documenting Classes
Documenting OOP Libraries
In this post, I explore how to document an OOP library. By following established documentation patterns, technical writers can create predictable, structured content that enables developers to leverage your software library efficiently and effectively. OOP documentation follows an imperative programming paradigm. This means that it focuses on how a program operates through a sequence of … Continue reading Documenting OOP Libraries
Programming Best Practices for Technical Writers – Modularity
Welcome to the sixth installment of my series on essential programming best practices for technical writers. In the previous post, I covered the concept of polymorphism. In this post, we’ll shift our focus to the principle of modularity. Modularity is a design strategy that involves dividing a system into smaller, self-contained units or modules, each … Continue reading Programming Best Practices for Technical Writers – Modularity
Programming Best Practices for Technical Writers – Polymorphism
Welcome to the fifth part of my series on essential programming best practices for technical writers. In the last post, I discussed the concept of reusability. On this post I’ll focus on the principle of polymorphism. Polymorphism allows objects from different classes to be treated as instances of a common superclass, enabling them to respond … Continue reading Programming Best Practices for Technical Writers – Polymorphism
Programming Best Practices for Technical Writers – Reusability
Welcome to the fourth installment of my series on essential programming best practices for technical writers. Previously, I explored the concept of abstraction. In this post, I'll delve into the principle of reusability. Reusability is about designing components, code, or modules so they can be utilized across various parts of a program or different projects … Continue reading Programming Best Practices for Technical Writers – Reusability
Programming Best Practices for Technical Writers – Abstraction
This is the third post in a series focused on the core principles of programming best practices for technical writers. The previous post covered inheritance and touched on abstract classes. In this one, we’ll dive deeper into the concept of abstraction. Abstraction involves hiding the complex implementation details of a system and presenting only the … Continue reading Programming Best Practices for Technical Writers – Abstraction
Programming Best Practices for Technical Writers – Inheritance
This is the second post in a series dedicated to exploring the fundamentals of programming best practices for technical writers. The first post detailed encapsulation. This one delves deeper into inheritance. Simply put, inheritance enables a new class (subclass) to inherit the methods and properties of an existing class (superclass). This creates a hierarchical structure of … Continue reading Programming Best Practices for Technical Writers – Inheritance
Programming Best Practices for Technical Writers – Encapsulation
This post marks the beginning of a series aimed at exploring essential programming best practices for technical writers, starting with the concept of encapsulation. Encapsulation involves hiding the internal workings of a system or component and exposing only necessary interfaces. For technical writers, this means being able to clearly document how users should interact with … Continue reading Programming Best Practices for Technical Writers – Encapsulation
Double Yew! 