article thumbnail

Socratic vs. Euclidean Forms of API Documentation

High Scalability

I was emailing a service about their documentation and while their doc was good, about one particularly tricky concept they told me that once you use it for a while, that’s when you’ll understand it. I want documentation that takes me from an unproductive newbie to a somewhat functioning journeyperson. It’s not easy.

Cloud 284
article thumbnail

Measuring Code Quality: Qualitative and Quantitative

DZone

Code Quality defines that the code is good, which means code is of high quality, and code is bad, which means code is of low quality. Code can be considered good quality if it is clear, simple, well tested, bug-free, refactored, documented, and performant.

Code 269
Insiders

Sign Up for our Newsletter

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

Trending Sources

article thumbnail

How to test code blocks in documentation

Percona Community

As any developer, I don’t like to write documentation. I often found myself copy-pasting something from documentation and trying to run it in the terminal (commands, files, etc.), I know that issue, and after writing the documentation, I usually try to clean up everything in my environment and test the doc.

Code 57
article thumbnail

Find vulnerabilities in your code—don’t wait for someone to exploit them

Dynatrace

All-new Dynatrace code-level vulnerability detection All-new Dynatrace code-level vulnerability detection evaluates all requests passing through your applications to identify vulnerabilities. The deep insights into application code provided by OneAgent® help track potentially vulnerable data flow within an application.

Code 201
article thumbnail

Interacting with Open Source for HammerDB Code and Documentation

HammerDB

When you install it you accept the license agreement and once installed there is a file called LICENSE headed GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 – so you know that the code is open source under GPLv3. But what about documentation? This means you have the freedom to contribute to the documentation as well.

article thumbnail

Self-documenting Architecture

Strategic Tech

I’ve heard the opinion from many technical leaders that it is reasonable to expect a new hire to take upto 6 months to learn about the code, the domain, and the architecture before they become fully productive. I believe that self-documenting architecture would dramatically reduce one of the big costs in software development.

article thumbnail

Generative AI poised to have impact by automating software development, report says

Dynatrace

In the research, “Code Transformed: Tracking the Impact of Generative AI on Application Development,” sponsored by Dynatrace, findings indicate that AI and automation are already having a major impact on how developers are working today. Source: Enterprise Strategy Group, a division of TechTarget, Inc.

Software 167