The AI Paradox in Technical Documentation

-

 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

Comments

Post a Comment

Popular posts from this blog

Troubleshooting Common Java Application Environment Issues (Azul)

-
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
Read more

Planning and Delivering Agile Documents

-
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...
Read more

Modern Web Applications

-
Modern web applicatiox (such as Google Docs) implement many coordinated user functions and tasks traditionally associated with desktop software (such as Microsoft Office).. Key topics include: • Open-Source Standards: The use of JavaScript, HTML5, and CSS. • MVC Architecture: Separation of concerns into Model, View, and Controller. • Single-Page Applications (SPA) enhance user experience without full page reloads. • Microapps: Breaking single-page applications into smaller, independent services. • Responsive Web Design: Ensuring web applications work on various devices. • Web Services: Using REST and SOAP for server-side communication. View publication
Read more