Which open source products do you use that have lousy documentation? [more inside]
posted by 27
on Jan 28, 2014 -
What are good examples of technical documents? examples: business policies, research papers, references, documentation [more inside]
posted by ichomp
on Jan 8, 2014 -
I am looking for examples of beautiful or unusual, yet effective, computer network diagrams - the more complex and extensive the networks, the better.
Similarly, I'd like to find tutorials and how-to's on making same - preferably avoiding Visio/OmniGraffle as much as possible (most of the people I work with just want to swap .pdfs or Power Point presentations when it comes to delivering design documents, anyhow.)
I deal with very intricate and large networks, and it's always a struggle to present them visually to various project stakeholders. I'd like to catch their attention with something striking that will help them actually understand what's going on.
posted by Slap*Happy
on Jan 7, 2014 -
I have to write several instructions manuals with screenshots. (Step-by-step documentation.)
What's the easiest way to do this? Any hacks or software recommendations? I want it to look nice and be easy to make. I don't have access to Photoshop or Illustration; free or very low cost would be ideal.
posted by melodykramer
on Oct 31, 2013 -
I have two user manuals, for two version of a product, which are 75% identical. They're currently Word documents. It's a pain to keep the parts in sync that I need to keep in sync. How can I do this the best way? [more inside]
posted by dmd
on Jul 11, 2013 -
The assault occurred in Panama, while I was working for a US-based nonprofit biology field school. I'm Canadian, and never had a contract with this institution. I was assaulted by an American coworker who targets the young women he comes into contact with via this job (and other lines of work, all as a teacher). I have a recording of him admitting what he did, and two recordings of the head of the organization explaining that he wont do anything and that he knows but doesnt care that this person is a predator. The recordings were made without permission. I've been told that the federal funding this organization receives would disappear if I could somehow find that granting agency and contact them with my complaint. What I'd really like to know is whether I could publish my recordings without legal repercussion, or what the outcome might be if I did, regardless. [more inside]
posted by qreus
on Apr 6, 2013 -
I do some developery-type stuff at work and the more complicated it gets, the less organized I am. I often find myself wondering why I did this or that or what I was trying to accomplish with it. I reuse a lot of the same functions and bits of code but I don't have a good system of keeping track of them. I know about commenting within code, and I do that, but I'm looking for a larger system of general best practices more than a specific solution. [more inside]
posted by desjardins
on Mar 12, 2013 -
I am writing some documentation for an app that runs on the iPhone, iPod Touch, and iPad. I need a consistant way to refer to these devices and am looking for something better than "iPhone/iPod/iPad". For example:
"Hold your iPhone/iPod/iPad's camera so that the QR code is centered in the brackets."
I've come up with either
"... iPhone/iPod/iPad (referred to as iPhone from here on)"
Anyone have a better idea?
posted by cosmac
on Dec 16, 2012 -
Last minute check list for US citizen with departing flight from Canada to Iceland to UK to Ireland, no return ticket and a car retuning with a different driver. [more inside]
posted by rmhsinc
on Oct 20, 2012 -
A friend would like me to save her some posts and comments from FB in a less ephemeral way. I'd like to copy them and make them into some sort of book or pamphlet for her. Have you done this sort of thing before and if so, how? I've seen Fonicle, which I think is a bit of overkill for this situation. [more inside]
posted by jvilter
on Oct 17, 2012 -
Does anyone know why academic PDF documents downloaded as full text seem to universally download as poorly documented/difficult to sort files? [more inside]
posted by infinite intimation
on Sep 11, 2012 -
My wife, a card-carrying permanent resident alien living in the U.S., allowed her German passport to expire and is seeking a renewal through the German Consulate in New York City. She has her documentation mostly in order, including German birth certificate, but needs to show proof of a name change that took place during an adoption in Iowa when she was four years old. Difficulty: Iowa adoption records are sealed. Looking for advice on how to best request a copy of the documentation, or provide a suitable alternative. Comprehensive details inside. [more inside]
posted by Joey Bagels
on Jul 23, 2012 -
User documentation/knowledgebases: Looking for best practices, great examples, and advice/instructional sites or publications. Also open to lowlights/worst-of resources. Analysis of how users engage with documentation would be useful, too. [more inside]
posted by batmonkey
on Apr 23, 2012 -
I have a few thousand pages of documentation I'd like to digitize and organize, eventually making a series of PDFs out of them. Can you help me make this task less painful? [more inside]
posted by subject_verb_remainder
on Apr 5, 2012 -
Does anyone have any tips for dealing with less savvy users of web-based WYSIWYG products like TinyMCE (which Wordpress uses) and/or improving the usability on the back-end? The best users I've worked with seem to universally use the HTML editor, while the rest fight with the visual editor to varying degrees of success. [more inside]
posted by yeahyeahyeahwhoo
on Mar 7, 2012 -
Can my undocumented friend drive my car? Can I drive his car? Will my insurance cover it and am I putting myself or him (or other drivers) at any risk? [more inside]
posted by anonymous
on Feb 10, 2012 -
Our company needs to create an application-level "runbook". We are an enterprise-level IT organization with no formalized documentation structure.
At the moment we are looking at building a custom runbook using SQL Server as a backend and Microsoft Access as a front-end, but the amount of time in doing this is immense. Is there a retail product that is set for us? [more inside]
posted by arniec
on Jun 21, 2010 -
I'm responsible for all the documentation at my workplace. I receive a few documents per day, and invariably they're somewhat badly written. So part of my process is that I edit them and clean them up before I post them on our intranet. Most folks like that I do this, but there are some who take it personally and consider the document to be "theirs" - because they wrote it. However, the document is really for other people, and if it's difficult for others to understand, or there are steps missing, or at worst it causes confusion, then it is not a good document and requires modification. How do I tactfully manage this? [more inside]
posted by forallmankind
on Jun 18, 2010 -
Which software projects' Web sites stand out as having really well-organized documentation? [more inside]
posted by tomwheeler
on May 25, 2010 -
Looking for an Application to search a file directory which contains php files (or any code, if it will work with PHP) and find all of the Database Tables which are referenced in the code, without relying on comments in the Code.
posted by jesirose
on Mar 26, 2010 -
How do I actually get the documentation that I have been asking for at work? [more inside]
posted by soelo
on Dec 20, 2009 -
I need help writing a detailed technical document in "for dummies" fashion. Is there a "for dummies" style guide as opposed to a style guide for dummies? [more inside]
posted by lysdexic
on Feb 11, 2009 -
I am several weeks away from leaving my job for a new one. As a result, I need to document my current development efforts for the several folks who will be taking over my responsibilities. My challenge is how to organize documentation about individual components with some additional flexibility. I’m looking for a method, or software, that would allow a thorough initial organization of documentation notes, but also enable other slices or views: show me all bits that live on server X, show me all of the bits that support application Y, what applications depend on script Z, etc. [more inside]
posted by jethrographic
on Nov 11, 2008 -
So, please help settle a dispute between myself and my boyfriend about Mozart and the musical capabilities of the average American. [more inside]
posted by WidgetAlley
on Sep 23, 2008 -
Despite having no training whatsoever, I've gradually become 'the IT guy' at work. I want to get organized and begin building a documentation file but I have no idea where to start. [more inside]
posted by wabashbdw
on Aug 4, 2008 -
I have a particular propriety database application that has a great feature for users to document notes and changes to the db. Annotated screenshot here
Basically, you click on the little yellow sticky note and the documentation window pops up and users can enter notes about changes, etc. Its so useful I would like to use it all the time.
posted by buttercup
on Apr 27, 2008 -
I am looking for real-life documents surrounding the development of a website. My organization is quite inexperienced in building a website from scratch and we are looking for some documents to get us started. Can anyone point us to some actual specifications, wireframes, test scripts, and project plans for website design and development?
posted by kaizen
on Oct 9, 2007 -
Is there wiki software that is specifically designed for writing books? By "book" I mean a long piece of writing designed to be read from start to finish, possibly broken up into chapters, and possibly with a TOC at the start and index at the end. [more inside]
posted by alms
on Sep 14, 2007 -
I am a technical writer looking to improve my company's software manuals. I want to stay up to date with the latest technology documentation trends. Please leave comments on what you think some of the best manuals are for different software products and why.
Basically, if you’ve ever read a software user manual and thought, “Wow! That was surprisingly easy to read…or helpful…or well organized…etc., then that is what we are looking for.
posted by JPowers
on Aug 27, 2007 -
What's the best software for writing and publishing software documentation?
posted by four panels
on Jan 31, 2007 -
I'm looking for Document Management software along the lines of MediaWiki that is extremely user-friendly and FAST, but has more security options and more ability to control edits. [more inside]
posted by owl
on Jan 22, 2007 -
What kind of documentation will convince a non-software guy that writing a program is actual work? [more inside]
posted by jacalata
on May 14, 2006 -
Can anyone point me to a good documentation/samples for building an app using mod_python and cheetah? (and mySQL/DBUtils etc)? [more inside]
posted by karen
on Feb 14, 2006 -
Help me figure out how to extract an XML schema in a .dtd file into lovely XML documentation. [more inside]
posted by dobie
on Dec 9, 2005 -
How best to manage software product documentation?
Our product docs are written in Microsoft Word and printed or shipped as PDF files. The online help is made by converting the Word files (in Robohelp) and adding lots of hyperlinks. This process has snags. [more inside]
posted by anadem
on Nov 2, 2005 -
Methods of Documentation: Getty My Work Onto Slide Film
Next weekend I am participating in an art show, my first in which work will be for sale, and because for one thing, I hung a piece in the silent auction, I have reason to believe I will sell at least one thing. (I have sold work before on commission, but this is still pretty exciting.)
I would like to have, in the future, in my portfolio, slides of any sold work. I do not have a tremendous budget but I'd rather spend a bit of cash than not have documentation of early sold work.
What method should I use to get my paintings and soforth onto slides? (See extended explanation).
Thanks much. I've got until the weekend to figure this out.
posted by tarintowers
on Oct 18, 2005 -
Suggestions for organizing and documenting employee performance that can be used in annual reviews? [more inside]
posted by cyniczny
on Aug 8, 2005 -
For the purpose of documentating an application, I'm looking for a WYSIWYG editor that can yield both in HTML and PDF formats, but meets a few other criteria. [More Inside] [more inside]
posted by turbodog
on Jun 14, 2005 -
Does anyone know of a program for Windows 2000/XP that will bring several different types of document files and image files together into one interface? This application should be able to reorder and renumber the pages accordingly. Also the tool must be able to export the end product into a universal format such as PDF or Word.
posted by airguitar
on Feb 22, 2005 -