Just added a few more basic examples of route parameter usage in Kitten to the routing sample app:

https://codeberg.org/kitten/app/src/branch/main/examples/routing

#Kitten #SmallWeb #routing #web #dev #documentation #examples

Got #LibreOffice 7.6, our new big release? Then also grab the accompanying Writer Guide for it: https://blog.documentfoundation.org/blog/2023/09/12/writer-guide-7-6-is-ready-for-you/ #foss #opensource #documentation

@shebang I'm afraid I cannot help.

I've learned long ago my brain is questionable at best with memory. A quick txt file in the future takes near zero effort.

#documentation

On dit souvent qu'un projet n'existe pas tant que sa documentation n'est pas publiée. On a donc décidé de la refaire de la cave au grenier, de telle sorte qu'elle permette aux gens de créer du contenu le plus facilement possible. Elle est accessible ici : https://nopefoundry.github.io/nope.gl (en anglais exclusivement, désolé !)

#documentation #graphics #motiondesign

@daria Simply better explanations.

I only ever use the #python #documentation to look up specific facts, like constants or string format codes. If I need to *understand* something I look for a tutorial elsewhere.

The docs, like a lot of technical #Wikipedia articles, value accuracy and precision over clarity and understanding.

First make me understand the mental model. Then tweak the specifics. Don't start with the details. #pedagogy #learning

Est-ce que vous auriez de la lecture à me conseiller sur comment écrire une bonne documentation ?

En français ou anglais.

J'ai jamais eu de formation là dessus, alors que j'ai suivi des études d'informatique à deux écoles différentes, deux diplômes différents.

Jusque là j'y allait au pif, mais je veux m'améliorer.

#DéveloppementLogiciel
#Documentation
#Informatique
#FLOSS
#FOSS

@lachlanhardy

A sample ‘use-case’ given:
“AngelList is remote first, and part of why it has been able to #scale is because of its focus on #documentation. Notion is where all this documentation lives — providing #guardrails for #structure, while also allowing teams to #customize based on how they want to share #teamspecific info.”

never used Notion, but a 10m read of their site, I see why it’s confusing. It’s a SAS for online businesses.

In SAS (big arse German accounting software Co.) you have consultants who do a business analysis of your work, create the product using s/w to customise input/reporting forms. And it works. Teams would do this, take months, years to do it.

Notion lets everyone define their use in what SHOULD be a ‘single product’ with API and software Wizards to build a custom use.

As it stands users are sold a bunch of vegetables. Now build your custom soup 😫🤓🤪

While #Psion in the early 90s seems to have used the same Word template for writing their public #documentation, there doesn't seem to have been a consistent "style guide."

Different parts of the SDK have clearly been written by different people. The HDK is not as polished. The 3a Programming Manual is different again, both in voice and in its heavy use of bold and italics.

As I go through the documents converting them to AsciiDoc, I wonder how much I should "tidy" the text.

#DigiPres

Today I improved the #documentation of the experimental EXT:l10ntable_extended and released a new #feature that allows non-admin backend users to specify the list of fields to edit themselves via #user #settings (via multi-select field).
#TYPO3

Le petit encard "Intended Audience" dans ce tuto : on stan <3

https://www.joshwcomeau.com/react/server-components/

#documentation #tutorial #bestPractice

Best section of software #documentation ever:
https://github.com/acdh-oeaw/WizKit#what-does-the-red-button-do

#teimec2023 #RSEng #musicology #DigitalHumanities

GitHub's documentation is insanely bad. Hint: Do not ever write "you can ..." in your documentation. Specify the problem and recommend a solution e.g.

Don't: "You can give permission to GitHub using the Floob interface".

Do: "To publish the page, give permission to GitHub using the Floob interface".

Also, while you're at it, read how to make your life easier by separating the 4 types of documentation: https://documentation.divio.com/

#software #documentation #badwriting #wtf #microsoft #github

Earlier today, after some hunting, I found the text version of the #OPL Programming Manual that came with the Series 3a. So, while I was sitting in front of the TV this evening, I thought I'd start converting it to #AsciiDoc.

First chapter is pretty much done.

I think (hope) I've got a paper copy in a box somewhere, so I can compare it to the original.

#Psion #RetroComputing #Documentation

@andypiper I've now gone a touch backwards on the "#automate everything" thing often favoured by "10X developers" and management. Similar to reducing dev to dev content I worry that automation can reduce people's [*] understanding of the underlying actions, making people don't have to learn them, and risk running into trouble if it goes wrong and needs to be debugged/changed ... Unless adequate #documentation are in place, which they often aren't
[*] - Except the person who wrote it

How do we organize #continuity and #security in the #BlueSpice #Cloud? Let's have a look. Check out the recording of our #ProductDays: https://youtu.be/JNZmOM6Z880/

#MediaWiki #Wiki #knowledgemanagement #documentation #opensource

I know writing a custom NSMergePolicy is rarely needed, but if you do find you need to write one, Apple’s lack of documentation makes it nearly impossible to diagnose if you do it wrong. I wrote the missing documentation so you don’t have to flounder around like I did.

TLDR: Be sure to call super, or else it all falls apart. Not intuitive, but the base merge policy respects your changes.

https://quigs.blog/how-to-write-a-custom-coredata-nsmergepolicy/

#CoreData #SwiftData #iOS #Apple #Developer #iOSDev #Documentation #Blog #HowTo

Orson update

Orson was developed as part of my PhD research, and now that I am just working on some Minor Corrections to my thesis, it is no longer a funded project.

That fact, together with a recent trip to the Outer Hebrides has meant that the development rate has been slower of late. I will be starting a new job very soon too, so updates will continue to be less frequent.

However. I will continue to work on it, and treat is as a long-term project, not least because I use it daily myself, but also because it hasn't yet achieved its potential with regards to my research interests. So expect more updates in future!

Most recently I have done considerable work in updating the Orson code base from Vue2 to Vue3 (not published yet) and in getting rid of a lot of duplicated code at the same time.

As Orson is an open-source project I encourage others to get involved, particularly because of the new limits on my time. One of my goals is to improve the plugin system, in order to encourage plugin authorship by contributors.

https://orsn.io

#orson
#research
#notebook
#documentation
#digitalhumanities
#knowledge
#vue
#javascript
#opensource
#software

Last night I was up until 3am because I was reading original #documentation of the #wang2200 #wordprocessor. Yes, I have #ADHD, how did you know?

www.wang2200.org is a great find still. 🤩

HIVE MIND: Can you give me some examples of good #retrocomputing documentation websites? Or any doc websites about an entire computing platform.

I'm looking for examples on which to model the #Psion #Documentation Project (https://doc.psion.info/). I want to give it a proper clean-up, formalise the structure somehow, and have some guidelines.

Positional Accuracy Assessment Of Digital Orthophoto Based On UAV Images - An Experience On An Archaeological Area
--
https://doi.org/10.3390/heritage4030071 <-- shared paper
--
#GIS #spatial #mapping #archaeology #archaeological #heritage #heritagebuildings #ancienthistory #culturalheritage #imagery #visualisation #orthoimagery #UAV #documentation ##accuracy #quality #precision #survey #surveying #KubadAbadPalace #Beyşehir #Konya #Anatolian #SeljukPalace #metrics #orthophoto #orthophotoaccuracy #archaeologicalheritage #ASPRS #Turkey