News for hackers. Stuff that matters.

DanieleProcida

Re:Diátaxis on Thursday August 06, 2026 @10:32AM (#49197228)
Re:Diátaxis on Saturday August 01, 2026 @06:58PM (#49139405)
I'd like to take advantage of the attention it's getting to point out that I am working on translating Diátaxis into other languages https://diataxis.fr/translation/, and you can see an in-progress version with some partially completed translations at https://diataxis-translated.readthedocs.io/translation/.
Re:Diátaxis on Saturday August 01, 2026 @06:54PM (#49139371)
Same fundamental ideas, but I got a lot of things wrong in that earlier version (which is several years old now).
Re:Diátaxis on Saturday August 01, 2026 @06:51PM (#49139331)
Ugh, I don't like that page and I have actually deleted it. It'll be gone soon.

There is a real problem there, and that page doesn't do a good enough job of dealing with it. I have something cooking that is much, much better.

Re:AI-bots shall eat my docs on Friday January 16, 2026 @03:30AM (#46644336)
An investigation into LLMs in the service of software documentation processes, by Sally Makin at Canonical

Ask HN: Which software companies hire people in Africa for remote work?

I want to compile a list of companies that will employ people from Africa to work remotely.I'm referring to full-time permanent roles offering stability and career progression, rather than piece work, short-term contracts or gig work.It would be particularly useful to know which companies actually have hired remote African team-members, and don't just offer "globally remote" jobs on paper.I...

( Read More... | 3 comments | 5 points | on HN )
Re:My favourite German word on Monday June 30, 2025 @01:09PM (#44425622)
If creators of documentation are prepared to sacrifice its human purpose in order that LLMs can more effectively slurp it up and regurgitate it on demand, then they have meekly accepted values that more properly belong in a dystopian horror story.
Re:Teaching on Monday June 02, 2025 @05:07AM (#44156975)
I don't believe teaching is really possible; I try to avoid doing it and I try to discourage other people from doing it too.
Re:Gandi Outage on Multiple Services on Monday March 10, 2025 @04:38AM (#43318182)
I have just been able to log in to my IMAP account. Only one new message in there, from two minutes ago - which suggests that all messages to me have not even reached the inbox yet.

Some deliveries will be retried, but after 30+ hours some will have permanently failed.

Re:Gandi Outage on Multiple Services on Monday March 10, 2025 @03:20AM (#43317780)
I have had excellent service and support from Gandi for several years. I appreciated having an EU-based provider that seemed to take pride in having a sustainable approach to the business. There was clarity about pricing. It wasn't the cheapest but they were straightforward and honest in communications.

Every company has an outage now and then, and sometimes a bad one.

But, it has now been 30 hours since I had access to my email. The last update was 15 hours ago. I don't like the way this has been handled.

> Also (separate complaint), whenever I want to tell anyone else about this "four kinds of documentation" approach, I always link to the archived https://web.archive.org/web/20200312220117/https://www.divio... which is the latest version that is entirely on a single page.

That's a mistake in my opinion. The big compass of four kinds of documentation I eye-catching and memorable, and I am sure it is part of the success of Diátaxis.

But what gets me out of trouble in my own work every time is https://diataxis.fr/compass/. It's one thing to have the general idea; it's another to be armed with an effective tool to apply to work.

The site doesn't just contain opinions and ideas, it also contains tools, that really are worth using.

Re:Documentation, development and design for technical authors on Thursday December 05, 2024 @06:05AM (#42326983)
How technical authors at Canonical influence the design and direction of software products
Re:Every Board Game Rulebook Is Awful [pdf] on Thursday December 05, 2024 @04:23AM (#42326451)
> I’m not that impressed with Diataxis, considering it is basically describing the approach of Django project’s docs

I worked on Django documentation and Diátaxis at the same time, so naturally you will see a lot of the same patterns.

Re:Every Board Game Rulebook Is Awful [pdf] on Thursday December 05, 2024 @04:20AM (#42326439)
There is no problem with Divio's site, see https://diataxis.fr/colophon/#origins-and-development. I started work on these ideas while still at Divio.
FAQ lists are the equivalent of the box in my garage where I put things when I've been told to get them out of the house, and I can't actually be bothered to put them in the right place.
Examples in reference material are an excellent idea, and not at all in contradiction to the principles of Diátaxis. An example illustrates - like an illustration in any other reference guide - and provides something concrete to help grasp what's being described.

That's different from a how-to, talking someone through a problem.

Why do you think the version on the Divio site is better - what's more intuitive about it?
Explained in https://diataxis.fr/colophon/#origins-and-development. No malfeasance! But I wish Divio would take that down, it's past its sell-by date now, and I think I got quite a few things in it wrong.
Re:Twelve rules for job applications and interviews on Tuesday September 03, 2024 @08:58AM (#41434520)
Twelve principles that job candidates can put into practice, to improve the quality of their applications and their performance in interviews.

Older »