# user guide

Published articles for user guide.

This is one page of public article previews, not the complete archive. Follow Next page to continue. Summaries are not the original full articles.

## Does AI-Generated Documentation Have Value?

DevFeed: [Does AI-Generated Documentation Have Value?](<https://devfeed.tech/articles/does-ai-generated-documentation-have-value-30751.md>)

Original publisher: [Read original article](<http://blog.vanillajava.blog/2025/01/does-ai-generated-documentation-have.html>)

Author: Peter Lawrey (noreply@blogger.com)

Published: 2025-01-10T17:42:00Z

Content type: opinion

Language: en

Sources: [Vanilla Java](<https://devfeed.tech/sources/vanilla-java.md>)

Topics: [Artificial Intelligence](<https://devfeed.tech/topics/ai.md>), [Documentation](<https://devfeed.tech/topics/documentation.md>), [user guide](<https://devfeed.tech/topics/user-guide.md>), [Code](<https://devfeed.tech/topics/code.md>)

Tags: [ai](<https://devfeed.tech/tags/ai.md>), [code](<https://devfeed.tech/tags/code.md>), [developers](<https://devfeed.tech/tags/developers.md>), [documentation](<https://devfeed.tech/tags/documentation.md>), [opinion](<https://devfeed.tech/tags/opinion.md>), [user-guide](<https://devfeed.tech/tags/user-guide.md>)

### AI overview

This opinion article evaluates the usefulness of AI-generated documentation. Based on a subjective review of generated user guides, it argues that most output is correct but uninteresting, while some content is wrong and a smaller portion is compelling. Reviewing and heavily editing the output can still reveal documentation improvements, corrections, testing ideas, performance checks, and clarifications.

### Source excerpt

As many have observed, at best, AI generates either: Mundane, repetitive documentation or code that most experts already know or If an expert doesn't know it, they can ask an AI to explain it anyway. Is it the case that if an AI can generate it, it's not worth adding to your documentation or code? While this is usually the case, there is still value in reading AI-generated documentation as a means of reviewing and validating what you might write differently. In this post, I show how changing the documentation can affect the AI's output and how reviewing it can be a useful exercise. Estimating the value of AI-generated documentation I tried to gauge the relative value of AI-generated documentation for my knowledge and set expectations for others. I asked o1 pro to generate user guides in several different ways I considered effective for: a simple class and package a large class and package a complex class and package Then, I subjectively estimated how many points made were compelling, interestingly incorrect, correct but not interesting, or just plain wrong. I ignored repeated points. This is what I concluded: Type Average points per query Percentage Correct but not interesting 35 80% Just plain wrong 5.4 13% Compelling to keep 2.1 5% Wrong But Interestingly 0.8 2% This assumes I crafted the query to be as specific as possible. Without a specific query, the AI can generate a lot of irrelevant or wrong content. Understandably, this can lead people to conclude that AI is unusable. However, there is still value in reviewing AI-generated documentation. Why Bother Reviewing AI-Generated Content? If we go into this process with the mindset that the content will be ruthlessly edited, we can extract value for relatively low effort. For example, each file I have reviewed had, on average approx 3 points that are compelling to keep or errors worth addressing. Is this point worth emphasising in your official documentation? Is the suggestion so far off that it needs immediate cor

## The Bastion host: How to set up and benefits of using it.

DevFeed: [The Bastion host: How to set up and benefits of using it.](<https://devfeed.tech/articles/the-bastion-host-how-to-set-up-and-benefits-of-using-it-19771.md>)

Original publisher: [Read original article](<https://cloud.blog.csc.fi/2019/07/the-bastion-host-how-to-set-up-and.html>)

Author: Unknown (noreply@blogger.com)

Published: 2019-07-03T07:24:00Z

Content type: tutorial

Language: en

Sources: [CSC - IT Center For Science - Cloud Team](<https://devfeed.tech/sources/csc-it-center-for-science-cloud-team.md>)

Topics: [Security](<https://devfeed.tech/topics/security.md>), [ssh](<https://devfeed.tech/topics/ssh.md>), [OpenSSH](<https://devfeed.tech/topics/openssh.md>), [Ansible](<https://devfeed.tech/topics/ansible.md>), [Network](<https://devfeed.tech/topics/network.md>), [servers](<https://devfeed.tech/topics/servers.md>)

Tags: [ansible](<https://devfeed.tech/tags/ansible.md>), [bastion](<https://devfeed.tech/tags/bastion.md>), [how-to](<https://devfeed.tech/tags/how-to.md>), [network](<https://devfeed.tech/tags/network.md>), [remote](<https://devfeed.tech/tags/remote.md>), [security](<https://devfeed.tech/tags/security.md>), [servers](<https://devfeed.tech/tags/servers.md>), [ssh](<https://devfeed.tech/tags/ssh.md>), [user-guide](<https://devfeed.tech/tags/user-guide.md>)

### AI overview

This tutorial explains bastion hosts as intermediary jump hosts for connecting to internal servers. It describes how they reduce exposure by keeping internal services off the internet and outlines setup using users, SSH ProxyCommand, an SSH configuration file, and Ansible playbooks.

### Source excerpt

What is a bastion host Bastion host just works like a jumphost, through which, we can connect to other servers. It can be used as an entry point to connect to internal servers which increases security as well. The following diagram can be useful to understand how we can connect to our internal hosts through a bastion host. The benefit of using bastion hosts One advantage using a bastion is the ability to use services which do not need to be directly accessible from internet, as in do not require a floating IP for each individual server. Most admin traffic and some user traffic can be tunnelled through the bastion host. The second and more important advantage is that by not having a floating IP the attack surface is reduced. A common mistake is that users are running inherently insecure services like network files system, databases, remote desktops a.s.o. and by mistake makes these services available to the internet. By not giving floating IPs to instances that run internal service you are eliminating one attack vector and also implement good practice of using layered security https://simple.wikipedia.org/wiki/Defense_in_depth_(computing). A bastion host itself has quite a small attack vector, for example in our example linked below we would only allow for incoming ssh traffic. How to create a bastion host We can make one host as our bastion host. To do so, we need to set up users in bastion host so that through bastion host, same users can pass through and log in to other internal servers and do administrative tasks. After setting up users in the bastion host, we can use proxycommand option of ssh to connect to other servers behind the bastion host. We also need a predefined ssh.config file. We can use ansible to make a host into a bastion host. Bastion git repo has some playbooks and an example ssh.config file. How to connect a host through a bastion host After we have set up our users in bastion host we can connect to our internal servers through a bastion host by