Mastodon Chapril

14 messages14 participants2 messages aujourd’hui

Kevin Karhan :verified:<a href="https://social.treehouse.systems/@ptrc" class="u-url mention" rel="nofollow noopener noreferrer" target="_blank">@ptrc</a> if one can't be assed to <a href="https://infosec.space/tags/code" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#code</a> and <a href="https://infosec.space/tags/document" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#document</a> themselves, why should I use their <a href="https://infosec.space/tags/software" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#software</a> or trust their <a href="https://infosec.space/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a>???

fcrnew & final status update on 'moving image zines rdam': The complete archive (355 videos) from 2005-2025 has been uploaded & is available on archive.org: <a href="https://archive.org/details/moving-image-zines-rdam?sort=-date" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://archive.org/details/moving-image-zines-rdam?sort=-date</a>All videos are downloadable as high-quality files [mp4/h264 codec, 32 Mbit/s] and reusable under the Creative Commons Attribution-ShareAlike 4.0 International license.<a href="https://post.lurk.org/tags/video" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#video</a> <a href="https://post.lurk.org/tags/movingimage" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#movingimage</a> <a href="https://post.lurk.org/tags/diy" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#diy</a> <a href="https://post.lurk.org/tags/rotterdam" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#rotterdam</a> <a href="https://post.lurk.org/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a>

Dave PearsonI've expanded the documentation for Hike (my <a href="https://fosstodon.org/tags/markdown" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#markdown</a> browser/reader for the <a href="https://fosstodon.org/tags/terminal" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#terminal</a>) and also moved it to its own little subdomain now:<a href="https://hike.davep.dev/" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://hike.davep.dev/</a><a href="https://fosstodon.org/tags/Python" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Python</a> <a href="https://fosstodon.org/tags/terminal" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#terminal</a> <a href="https://fosstodon.org/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a>

El DuvelleGood <a href="https://neuromatch.social/tags/Coding" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Coding</a> practices question for <a href="https://neuromatch.social/tags/Documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Documentation</a>:Are there some general guidelines on what info to put in the comment at the top of each code file? Like date, author, basic description of what the code does? Maybe something about dependencies? Are there templates for this somewhere (e.g. for <a href="https://neuromatch.social/tags/Matlab" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Matlab</a> or <a href="https://neuromatch.social/tags/Python" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Python</a> if that matters)?

Dave<a href="https://chaos.social/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a> so the e-bike brake handle had an OH137 hall effect sensor in its case and a magnet. Let's hope I can fix that lel

RegistrarTrekFocus on what you CAN do, not what you CAN’TIn these past few weeks it seems that there were so many horrible things happening that just making a list of them feels overwhelming and exhausting. Some of the decisions of the current U.S. government have an impact on the global level, others hit people personally, some of whom are close friends. And then, there are those who seem to target the very core of our profession, like the shutting down of the Institute of Museum and Library Services (IMLS) and the termination of grants already awarded by the National Endowment of the Humanities (NEH).<a href="https://world.museumsprojekte.de/wp-content/uploads/2017/08/ninja-155848_640.png" rel="nofollow noopener noreferrer" target="_blank"></a>It is hard not to lose all hope in this climate. And yet, aren’t we, as museum professionals, used to things not really looking pretty? Haven’t we battled budget and staff cuts before? Haven’t we brought uncomfortable truths in front of the eyes of our visitors and politicians before? Maybe the current crisis is not comparable to what we were confronted with before. But just as well, we are well trained in going against adversarial circumstances.We have always done so with resilience, creativity, and, most of all, a sense of community. We might be spread out across the world and we might have spread ourselves thin by taking on too many responsibilities, but we are not alone. I have reached out to my network over the past few days to check in on some people, see how they are coping, and getting ideas of what can be done, because, in the end, focusing on what can’t be done never made anything better.Turns out that John E. Simmons had already started collecting what can be done to prepare for what is coming at us in something we registrars love: A list. I contributed a few of my thoughts to it and we also asked some more colleagues to add to it. What I am posting here today is by no means a comprehensive and finalized list of what to think about and what to do, but it is a start. Feel free to add more ideas in the comments section, just like we enhance it going forward.What Can We Do?1. Apply the lessons that museums learned from Covid<ul><li>A museum should have a plan for suddenly shutting down or having to reduce staff for a prolonged long period of time.</li><li>The plan should include cross-training for all staff so that a reduced staff can keep the institution functioning and care for the collections. Every staff member should be trained to do tasks that are normally not part of their duties so that they can help in the event of a prolonged emergency.</li><li>The plan should include what the museum can do to remain a destination for visitors during a crisis. This might include regulating the number of visitors in the museum at the any one time during a pandemic, reducing or eliminating admission fees for visitors during a prolonged financial crisis, and how responsibilities could be handled by a reduced staff. It is worth noting that a recent study revealed that art museums that charge admission spend an average of $100 per visitor but attract smaller audiences than free museums, and that there are costs associated with collecting admission fees that may not be recovered by the fee. Details can be found at <a href="https://news.artnet.com/art-world/us-museums-visitors-report-2622358" rel="nofollow noopener noreferrer" target="_blank">https://news.artnet.com/art-world/us-museums-visitors-report-2622358</a>).</li></ul>2. Prepare the collections for long-term, low maintenance storage by preparing the most sustainable and passive storage environment possible:<ul><li>Improve the effectiveness of the collection storage furniture, containers, and supports to protect the collections (e.g., replace gaskets on doors, eliminate acidic materials, reduce lighting and UV in storage).</li><li>Keep the collection in order (each object in its proper place in storage) at all times (do not allow a backlog of out-of-place objects to build up).</li><li>Improve environmental controls and environmental monitoring procedures.</li><li>Maintain storage environment equipment in good order (e.g. replace filters, service equipment regularly, replace aging HVAC systems).</li></ul>3. Protect the databases<ul><li>Make sure that you have a fully up-to-date, readable copy of all important museum databases stored somewhere outside of the building, preferably in a hard format as well as electronic.</li><li>Make sure that both on-site and off-site databases are protected so they cannot be accessed by unauthorized personnel. Renew passwords and other project on a frequent, regular basis.</li><li>If the institution is forced to close, and you have a good backup copy, consider removing databases from the museum servers to protect confidential information.</li><li>When possible look into storing backup copies of your databases that are not only readable in a proprietary format of one vendor (who might be forced to hand your sensitive data over or might go out of business). If you database allows for it, export your important data as SQL tables or as comma separated values (.csv). Excel formats such as xlsx, xls, or ods are fine, too.</li><li>When possible move your sensitive data to trusted servers outside the U.S. that don’t belong to U.S. based companies who might be forced to hand your sensitive data over or delete your data. </li><li>As a rule of thumb: make access to your data for your trusted staff as easy as possible, but make deleting data from your database hard by setting up a robust rights management and whenever possible enable procedures to revert to earlier data entry points.</li></ul>4. Update the institutional emergency preparedness plan to include procedures for coping with sudden, prolonged shutdowns of the building.5. Stock up on critical supplies6. Download anything needed from federal websites (such as the NPS Museum Handbook and Conserve O Grams or IMLS reports) immediately, while the information is still available. Store this data in a safe place that is only accessible to authorized personnel and make deleting those resources as hard as possible.7. Keep in mind that most serious problem going forward will probably not be the cuts in federal funding to the NIH, NEA, NSF, IMLS, etc., because most of this money goes to projects which can be postponed or funded by other sources (such as donations). The most serious problem will be the lack of funds resulting from damage done to the economy due to a combination of the rising deficit, increasing unemployment (e.g., the mass reductions in the federal workforce and corresponding loss of jobs in sectors that serve the federal workforce), and decreased tax revenues due to tax cuts for the wealthy, tariffs on imports, and cuts to social services. In other words, the predicted problems with the US economy are far more likely to be a bigger problem for museums than the loss of federal grant funds.Words of Cheer:<ul><li>Museums existed long before the IMLS and other federal granting agencies, so they can survive this period, although many worthy projects and much research will be halted unless alternative funding can be found.</li><li>With preparation, museums can survive the coming crisis as they have survived other crises. There will be staff reductions and loss of opportunities, but with any luck, the situation will change within a few years.</li><li>Take a good look at your policies and procedures and investigate new laws and executive orders you are confronted with. Laws that are passed in a great hurry often contain contradictions and loopholes. Often asking for clarifications by authorities can slow processes down and work to your advantage. Often stalling a process in good faith can be much more effective than open opposition which puts you and your staff at risk.</li><li>Be prepared to be patient. Lawsuits and judicial decisions challenging the proposed changes will take time to go through the courts.</li><li>In the longer term, climate change and its effects on museum operations, the economy, and the behavior of the public is the greatest challenge to the future of museums, so the present crisis should be used to prepare for the future.</li></ul>Best Advice:If your institution does not have a plan for long-term survival during a financial crisis, the next pandemic, or climate change, get busy now to correct this deficit.Helpful Information<ul><li>Learnings museums made from the Covid-19 pandemic, <a href="https://www.ne-mo.org/news-events/article/learnings-museums-made-from-the-covid-19-pandemic" rel="nofollow noopener noreferrer" target="_blank">https://www.ne-mo.org/news-events/article/learnings-museums-made-from-the-covid-19-pandemic</a></li></ul><ul><li>PEAS Resource Library (Promoting Exhibit Access and Safety), <a href="https://ncp.si.edu/PRICE-PEAS" rel="nofollow noopener noreferrer" target="_blank">https://ncp.si.edu/PRICE-PEAS</a></li></ul><ul><li>Snider, Julianne. 2024. The Wheel is Already Invented: Planning for the Next Crisis. Collections: A Journal for Museum and Archives Professionals 20(2):347-359, DOI: 10.1177/15501906241232309</li></ul><ul><li>Living in a Wild Future (Center for the Future of Museums blog), <a href="https://www.aam-us.org/2025/03/04/living-in-a-wild-future/" rel="nofollow noopener noreferrer" target="_blank">https://www.aam-us.org/2025/03/04/living-in-a-wild-future/</a></li></ul><ul><li>Decrease in Public Funding? A Worldwide Answer from Museums (ICOM), <a href="https://icom.museum/wp-content/uploads/2025/01/IRAPFM-A4-Format_FINAL.pdf" rel="nofollow noopener noreferrer" target="_blank">https://icom.museum/wp-content/uploads/2025/01/IRAPFM-A4-Format_FINAL.pdf</a></li></ul><ul><li>Susana Smith Bautista (2021)—How to Close a Museum. A Practical Guide (Rowman & Littlefield)</li></ul><ul><li>Here is an additional list of resources in case you have to close down your institution: <a href="https://world.museumsprojekte.de/wp-content/uploads/2025/04/ResourcesMuseumsClosing.pdf" rel="nofollow noopener noreferrer" target="_blank">https://world.museumsprojekte.de/wp-content/uploads/2025/04/ResourcesMuseumsClosing.pdf</a></li></ul><ul><li>Christopher J. Garthe (2023)—The Sustainable Museum. How Museums Contribute to the Great Transformation (Routledge)</li></ul>Some more notesShare this resource freely with anyone you think needs to see this, no need to ask for permission. Add what applies to your special case. Let us know what we should add. Download, save, print, circulate.<a href="https://world.museumsprojekte.de/wp-content/uploads/2025/04/WhatCanWeDo-2.pdf" rel="nofollow noopener noreferrer" target="_blank">Download List as PDF</a>Registrar Trek is hosted on a server in Germany and following EU laws. I am currently looking through all the plug-ins I use to make sure none of them collects and shares any personal data with the U.S. Or, in fact, anybody. I always was mindful not to collect any personal information but will double-check again if everything is safe.Hang on in there, you are not alone!<a rel="nofollow noopener noreferrer" class="hashtag u-tag u-category" href="https://world.museumsprojekte.de/tag/budgetcuts/" target="_blank">#BudgetCuts</a> <a rel="nofollow noopener noreferrer" class="hashtag u-tag u-category" href="https://world.museumsprojekte.de/tag/collections-management/" target="_blank">#collectionsManagement</a> <a rel="nofollow noopener noreferrer" class="hashtag u-tag u-category" href="https://world.museumsprojekte.de/tag/documentation/" target="_blank">#documentation</a> <a rel="nofollow noopener noreferrer" class="hashtag u-tag u-category" href="https://world.museumsprojekte.de/tag/grant-erasure/" target="_blank">#grantErasure</a> <a rel="nofollow noopener noreferrer" class="hashtag u-tag u-category" href="https://world.museumsprojekte.de/tag/grants/" target="_blank">#grants</a> <a rel="nofollow noopener noreferrer" class="hashtag u-tag u-category" href="https://world.museumsprojekte.de/tag/imls/" target="_blank">#IMLS</a> <a rel="nofollow noopener noreferrer" class="hashtag u-tag u-category" href="https://world.museumsprojekte.de/tag/museum/" target="_blank">#museum</a> <a rel="nofollow noopener noreferrer" class="hashtag u-tag u-category" href="https://world.museumsprojekte.de/tag/neh/" target="_blank">#NEH</a> <a rel="nofollow noopener noreferrer" class="hashtag u-tag u-category" href="https://world.museumsprojekte.de/tag/preparing-for-shutdown/" target="_blank">#preparingForShutdown</a> <a rel="nofollow noopener noreferrer" class="hashtag u-tag u-category" href="https://world.museumsprojekte.de/tag/registrar/" target="_blank">#registrar</a>

Monospace MentorInteresting read: "Five solutions to link rot in my personal note collection"<a href="https://writingslowly.com/2025/03/30/five-solutions-to-link-rot.html" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://writingslowly.com/2025/03/30/five-solutions-to-link-rot.html</a><a href="https://floss.social/tags/writing" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#writing</a> <a href="https://floss.social/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a> <a href="https://floss.social/tags/knowledgemanagement" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#knowledgemanagement</a>

OpenProject📽️ Do you agree? High-quality documentation is essential — especially for feature-rich software like OpenProject.That’s why we keep our guides up to date in English, German, Spanish, French — and soon Portuguese! — while also investing in video tutorials.In our latest blog article, we share our approach to great documentation and video content, and introduce Dicle, our new Video Production Manager:<a href="https://www.openproject.org/blog/video-documentation/" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://www.openproject.org/blog/video-documentation/</a><a href="https://fosstodon.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Documentation</a> <a href="https://fosstodon.org/tags/OpenSource" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#OpenSource</a> <a href="https://fosstodon.org/tags/ProjectManagement" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#ProjectManagement</a> <a href="https://fosstodon.org/tags/OpenProject" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#OpenProject</a> <a href="https://fosstodon.org/tags/Software" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Software</a>

Markus EiseleCrafting READMEs for AI <a href="https://benhouston3d.com/blog/crafting-readmes-for-ai" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://benhouston3d.com/blog/crafting-readmes-for-ai</a> <a href="https://mastodon.online/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a> <a href="https://mastodon.online/tags/aiml" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#aiml</a>

Roger LightAnd this is a possible update. The command synopsis is now split up into multiple logical sections to make it easier to find related options and ignore ones you aren't interested in. As a consequence, it occupies about a full screen height.I think it's clearer, but I'm concerned the large amount of screen use is offputting.Any thoughts?<a href="https://fosstodon.org/tags/mosquitto" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#mosquitto</a> <a href="https://fosstodon.org/tags/mqtt" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#mqtt</a> <a href="https://fosstodon.org/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a>

LaurenAngel sightseeing Installation still from a moving interactive performance and imagination construct We create stories of love and heartbreak <a href="https://pixelfed.social/discover/tags/angel?src=hash" class="u-url hashtag" rel="nofollow noopener noreferrer" target="_blank">#angel</a> <a href="https://pixelfed.social/discover/tags/Installation?src=hash" class="u-url hashtag" rel="nofollow noopener noreferrer" target="_blank">#Installation</a> <a href="https://pixelfed.social/discover/tags/theater?src=hash" class="u-url hashtag" rel="nofollow noopener noreferrer" target="_blank">#theater</a> <a href="https://pixelfed.social/discover/tags/mixedmediaart?src=hash" class="u-url hashtag" rel="nofollow noopener noreferrer" target="_blank">#mixedmediaart</a> <a href="https://pixelfed.social/discover/tags/arte?src=hash" class="u-url hashtag" rel="nofollow noopener noreferrer" target="_blank">#arte</a> <a href="https://pixelfed.social/discover/tags/artecontemporanea?src=hash" class="u-url hashtag" rel="nofollow noopener noreferrer" target="_blank">#artecontemporanea</a> <a href="https://pixelfed.social/discover/tags/artecontemporaneo?src=hash" class="u-url hashtag" rel="nofollow noopener noreferrer" target="_blank">#artecontemporaneo</a> <a href="https://pixelfed.social/discover/tags/photography?src=hash" class="u-url hashtag" rel="nofollow noopener noreferrer" target="_blank">#photography</a> <a href="https://pixelfed.social/discover/tags/documentation?src=hash" class="u-url hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a> <a href="https://pixelfed.social/discover/tags/contemporaryart?src=hash" class="u-url hashtag" rel="nofollow noopener noreferrer" target="_blank">#contemporaryart</a> <a href="https://pixelfed.social/discover/tags/installationart?src=hash" class="u-url hashtag" rel="nofollow noopener noreferrer" target="_blank">#installationart</a>

Chi ha ucciso Il Conte?Docomentation is very important... here is a short assembly manual that I made for the Chowndolo, using <a href="https://c.im/tags/freecad" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#freecad</a> and <a href="https://c.im/tags/inkscape" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#inkscape</a> as usual @la.lepre @halldorophone @intelligentinstruments <a href="https://c.im/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a> <a href="https://c.im/tags/cad" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#cad</a> <a href="https://c.im/tags/floss" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#floss</a> <a href="https://c.im/tags/axonometric" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#axonometric</a> <a href="https://c.im/tags/2d" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#2d</a> <a href="https://c.im/tags/design" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#design</a> <a href="https://c.im/tags/vectorgraphics" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#vectorgraphics</a> <a href="https://c.im/tags/instructionspamphlet" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#instructionspamphlet</a> <a href="https://c.im/tags/instructions" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#instructions</a> <a href="https://c.im/tags/sound" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#sound</a> <a href="https://c.im/tags/musicalinstruments" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#musicalinstruments</a> <a href="https://c.im/tags/assembly" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#assembly</a>

Alfonso SicilianoI am working on creating a handbook that describes the assistive technologies available in the FreeBSD operating system, which will be freely available online for anyone to consult. Currently, the effort is focused on gathering and documenting accessibility features for visual impairments, and it is sponsored by the <a href="https://mastodon.social/@FreeBSDFoundation" class="u-url mention" rel="nofollow noopener noreferrer" target="_blank">@FreeBSDFoundation</a> If you are interested in the topic, a public repository is available for suggestions and corrections: <a href="https://gitlab.com/alfix/freebsd-accessibility" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://gitlab.com/alfix/freebsd-accessibility</a><a href="https://mastodon.bsd.cafe/tags/FreeBSD" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#FreeBSD</a> <a href="https://mastodon.bsd.cafe/tags/UNIX" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#UNIX</a> <a href="https://mastodon.bsd.cafe/tags/OpenSource" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#OpenSource</a> <a href="https://mastodon.bsd.cafe/tags/Accessibility" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Accessibility</a> <a href="https://mastodon.bsd.cafe/tags/a11y" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#a11y</a> <a href="https://mastodon.bsd.cafe/tags/Blindness" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Blindness</a> <a href="https://mastodon.bsd.cafe/tags/LowVision" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#LowVision</a> <a href="https://mastodon.bsd.cafe/tags/ColorBlindness" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#ColorBlindness</a> <a href="https://mastodon.bsd.cafe/tags/AssistiveTechnologies" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#AssistiveTechnologies</a> <a href="https://mastodon.bsd.cafe/tags/Inclusion" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Inclusion</a> <a href="https://mastodon.bsd.cafe/tags/Documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Documentation</a> <a href="https://mastodon.bsd.cafe/tags/Coding" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Coding</a>

Miguel Afonso Caetano"The following are my suggestions regarding what else to consider for each of Daryl White’s excellent questions about choosing a toolset for documenting a software product or project.I have appended a brief guide to the main/broad categories of documentation toolsets and some of the platforms/components that are popular in each.Finally, this resource ends with a table of possible solutions for various scenarios you might find yourself in.Before we start with the existing list of questions, I want to highlight one that I think is most important of all, but which is often assumed by people who create these kinds of guides, as they tend to come from one or another world already.What are you documenting?When it comes to software technical writing, the more appropriate way to ask this might be: For what user roles is your documentation intended?For graphical end-user interfaces (GUIs), the largest range of docs tooling is available, but here some of the more commercial turnkey tools have most of their advantages.For administrator interfaces (installation, configuration, etc), again any tooling will work, but we start seeing real advantages for lightweight markup, codebase integration, and version control.For developer interfaces, docs-as-code offers significant advantages. Developers can better contribute directly, and it’s generally friendlier for coded samples. APIs (native and remote), SDKs, and CLIs are almost certainly best documented in a docs-as-code environment, even if you integrate it with a more conventional platform for end-user docs."<a href="https://gist.github.com/briandominick/d4cbe11228de0ebe31cda630976af4ef" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://gist.github.com/briandominick/d4cbe11228de0ebe31cda630976af4ef</a><a href="https://tldr.nettime.org/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalWriting</a> <a href="https://tldr.nettime.org/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#SoftwareDocumentation</a> <a href="https://tldr.nettime.org/tags/Documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Documentation</a> <a href="https://tldr.nettime.org/tags/DocsAsCode" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#DocsAsCode</a> <a href="https://tldr.nettime.org/tags/TechnicalCommunication" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#TechnicalCommunication</a> <a href="https://tldr.nettime.org/tags/InformationArchitecture" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#InformationArchitecture</a> <a href="https://tldr.nettime.org/tags/CCMS" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#CCMS</a>

Frontend DogmaAutomatically Generate Changelogs With Git, by <a href="https://mastodon.social/@danrot" class="u-url mention" rel="nofollow noopener noreferrer" target="_blank">@danrot</a>:<a href="https://danielrotter.at/2025/03/05/automatically-generate-changelogs-with-git.html" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://danielrotter.at/2025/03/05/automatically-generate-changelogs-with-git.html</a><a href="https://mas.to/tags/git" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#git</a> <a href="https://mas.to/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a> <a href="https://mas.to/tags/automation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#automation</a>

Frontend DogmaHow GitHub Engineers Learn New Codebases, by @brittanyellich.com (<a href="https://hachyderm.io/@github" class="u-url mention" rel="nofollow noopener noreferrer" target="_blank">@github</a>):<a href="https://github.blog/developer-skills/application-development/how-github-engineers-learn-new-codebases/" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://github.blog/developer-skills/application-development/how-github-engineers-learn-new-codebases/</a><a href="https://mas.to/tags/github" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#github</a> <a href="https://mas.to/tags/learning" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#learning</a> <a href="https://mas.to/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a>

kalvnPas mal de conseils pour écrire des documentations techniques utiles et efficaces.🔗 <a href="https://developer.mozilla.org/en-US/blog/technical-writing/" rel="nofollow noopener noreferrer" translate="no" target="_blank">https://developer.mozilla.org/en-US/blog/technical-writing/</a><a href="https://mastodon.xyz/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a> <a href="https://mastodon.xyz/tags/conseil" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#conseil</a> <a href="https://mastodon.xyz/tags/astuce" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#astuce</a>

Kevin Karhan :verified:<a href="https://mstdn.ca/@AnnieBuddy" class="u-url mention" rel="nofollow noopener noreferrer" target="_blank">@AnnieBuddy</a> <a href="https://mathstodon.xyz/@mjd" class="u-url mention" rel="nofollow noopener noreferrer" target="_blank">@mjd</a> <a href="https://hachyderm.io/@simontatham" class="u-url mention" rel="nofollow noopener noreferrer" target="_blank">@simontatham</a> <a href="https://mendeddrum.org/@fanf" class="u-url mention" rel="nofollow noopener noreferrer" target="_blank">@fanf</a> +1Unlike a <a href="https://infosec.space/tags/Video" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Video</a>, I can actually <a href="https://infosec.space/tags/search" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#search</a> a <a href="https://infosec.space/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a> and unlike a video, I can get a translation either automated or at an acceptable price.

Vengeur MasquéDo you know the difference between <a href="https://mastodon.hofud.com/tags/Microsoft" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Microsoft</a> <a href="https://mastodon.hofud.com/tags/Azure" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Azure</a> <a href="https://mastodon.hofud.com/tags/API" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#API</a> <a href="https://mastodon.hofud.com/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a> and the <a href="https://mastodon.hofud.com/tags/Necronomicon" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#Necronomicon</a>?None. Nobody could read them and keep their sanity.

🎥 Cinémathèque de Bretagne 🎥[BÉNÉVOLES • TUD A-YOUL VAT] Depuis quelques semaines, de nombreux·ses <a href="https://mastodon.social/tags/b%C3%A9n%C3%A9voles" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#bénévoles</a> viennent nous prêter main forte sur le chantier des collections : catalogage d'ouvrages sur le <a href="https://mastodon.social/tags/cin%C3%A9ma" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#cinéma</a>, tri et numérisation d'<a href="https://mastodon.social/tags/archives" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#archives</a> administratives, nettoyage et remise en état des <a href="https://mastodon.social/tags/appareils" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#appareils</a>, <a href="https://mastodon.social/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#documentation</a> de <a href="https://mastodon.social/tags/films" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#films</a>... Une aide précieuse pour préparer sereinement le déménagement de la Cinémathèque de Bretagne dans ses nouveaux locaux dans les mois à venir ! Un grand merci à toutes et tous !

Recherches récentes

Options de recherche

Administré par :

Statistiques du serveur :

#documentation