Search This Blog

Clear and Concise

This portfolio of documents illustrate how artificial intelligence. Web 2.0 technologies, open-source software, and agile development are changing the way that products and services are documented.

The AI Paradox in Technical Documentation

Get link
Facebook
X
Pinterest
Email
Other Apps

- March 07, 2026

The very techniques that define good professional technical writing are the same signals that AI detection methods use as evidence of machine generation.

View Publication

Get link
Facebook
X
Pinterest
Email
Other Apps

Comments

Troubleshooting Common Java Application Environment Issues (Azul)

- June 02, 2022

The article was created for a Java ( https://www.azul.com/products/core/ ) developer and administrator audience that required that concept, reference, and task information be written from scratch. My accomplishments included: Collaborated with development and system engineers to create a knowledgebase article to troubleshoot common Java application issues. Executed Java applications in cloud environments (such as VMware vSphere and Linux KVM) to verify task and reference information. View Publication

Sun ONE Portal Server Migration Guide (Sun Microsystems)

- June 02, 2022

Reviewed and updated product documentation prior to every product release (every six months for four years) to reduce technical support calls for implementing and deploying services on Sun Java System Portal Server ( https://en.wikipedia.org/wiki/Sun_Java_System_Portal_Server ). View Publication

Planning and Delivering Agile Documents

- July 18, 2022

The impact on documentation is huge when project teams adopt agile practices to plan and deliver products and services. Key Takeaways: Agile Principles and Technical Documentation: Agile development prioritizes working software, collaboration, and adaptability, which significantly impacts technical documentation. Shift from Formal Specifications: In agile, writers must rely on working software, not formal specifications, to create documentation. Dynamic Documentation: Agile emphasizes creating documentation that is relevant, stable, and continuously updated based on feedback. Audience Analysis: Understanding the target audience is crucial for creating effective documentation. User Stories and Tasks: User stories and tasks provide a structured approach to breaking down documentation requirements. Continuous Delivery and Kanban: Agile's focus on continuous delivery and the use of kanban boards help ensure that documentation aligns with the evolving product. The article also inc...