Skip

58 posts tagged with documentation.
Displaying 1 through 50 of 58. Subscribe:

Software skills for aspiring technical writer

How do I know I’ve taught myself enough technical writing software (number of programs and my abilities therein) for potential employers to take me seriously? [more inside]
posted by glass.hourousha on Jul 23, 2014 - 6 answers

Genealogy-specific digitalization services?

How can I help my dad digitize his extensive collection of genealogical documentation? [more inside]
posted by Riki tiki on Jul 15, 2014 - 1 answer

Looking for a relational wiki for documentation.

Greetings hive mind! This seems to be something that should already exist, but I think I either haven't found the right type of wiki, or have looked over the feature in one of the many wikis I've tried. Basically, I'm looking to use a wiki for IT documentation purposes...but I'd also like for it to be able to automatically propagate views/pages in a relational manner (either via the backend or via templates). Here's an example to help illustrate: [more inside]
posted by samsara on Jul 8, 2014 - 6 answers

The Best Online Help Portals

Which websites/web services offer the very best online help portal, where you can get documentation and videos on their product? [more inside]
posted by JPowers on May 19, 2014 - 1 answer

Unemployed technical writer seeks open source project in need.

Which open source products do you use that have lousy documentation? [more inside]
posted by 27 on Jan 28, 2014 - 20 answers

Good examples of technical writing

What are good examples of technical documents? examples: business policies, research papers, references, documentation [more inside]
posted by ichomp on Jan 8, 2014 - 6 answers

In search of beautiful network diagrams

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 - 7 answers

How to Display Instructions?

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 - 14 answers

Word alternatives for writing user manuals with lots of shared content?

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 - 9 answers

Legal advice regarding publishing documentation of sexual assult

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 - 22 answers

Best practices for software development documentation

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 - 15 answers

What is a good single term for Apple iPhone/iPod Touch/iPad?

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)" or "IOS device" Anyone have a better idea?
posted by cosmac on Dec 16, 2012 - 12 answers

necessary documentaton for international flights and auto travel.

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 - 7 answers

How to capture a set of posts and comments from Face Book?

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 - 6 answers

1-s2.0-S0958166910000443-main dot PDF

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 - 14 answers

Screen capture software options for application documentation

What are good tools for making app documentation videos, which focus on the specific region of interest? [more inside]
posted by Blazecock Pileon on Aug 27, 2012 - 9 answers

Help my wife prove her identity to the German Consulate

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 - 5 answers

Help Us Spring Clean Our Documentation

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 - 0 answers

Turning thousands of loose-leaf papers into dozens of PDFs

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 - 8 answers

Dealing with Wordpress and Web-based WYSIWYGs

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 - 4 answers

Can my undocumented friend drive my car? Can I drive his? How do we stay safe?

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 - 9 answers

What should I use to create an internal manual for my department?

What is the best (Mac compatible) program/thing to use to write an internal manual for my department at work? [more inside]
posted by insufficient data on Dec 29, 2011 - 6 answers

Help us sprint.

Can you recommend some free tools that can help generate timeline estimates? [more inside]
posted by methroach on Jul 26, 2011 - 5 answers

What's the best way to learn about formatting documents?

What's the best way to learn about formatting documents? [more inside]
posted by forallmankind on Aug 23, 2010 - 10 answers

Which mortgage documents need backups?

Which mortgage/refi documents should have a backup copy? [more inside]
posted by tomwheeler on Jul 4, 2010 - 2 answers

Don't want to rewrite the book on runbook

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 - 5 answers

How Do I Tactfully Manage Emotional Writers

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 - 23 answers

Looking for great examples of organizing developer documentation

Which software projects' Web sites stand out as having really well-organized documentation? [more inside]
posted by tomwheeler on May 25, 2010 - 17 answers

Help me find an off the shelf video system for documenting a technical process.

Help me find an off the shelf video system for documenting a technical process. [more inside]
posted by jackofsaxons on May 1, 2010 - 7 answers

Application for PHP Documentation of Tables

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 - 5 answers

I just want some answers!

How do I actually get the documentation that I have been asking for at work? [more inside]
posted by soelo on Dec 20, 2009 - 6 answers

Not Actually Written By Dummies

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 - 4 answers

Advice on documentation tagging?

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 - 3 answers

I can haz Mozart too?

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 - 30 answers

How does IT documenation work?

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 - 18 answers

document my database

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. [more inside]
posted by buttercup on Apr 27, 2008 - 3 answers

where are the docs?

How do I access the C documentation that's on my computer? [more inside]
posted by tylermoody on Oct 25, 2007 - 6 answers

Cliff-Notes for a Web Project

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 - 7 answers

Wiki for Writing Books?

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 - 6 answers

Software Documentation

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 - 12 answers

How to create one gigantic JavaDoc file?

For-a-friend-filter: Help with JavaDoc. [more inside]
posted by Khalad on Jul 9, 2007 - 3 answers

Should I trust passport expediting services?

Are passport expediting services legit? [more inside]
posted by Afroblanco on May 1, 2007 - 25 answers

Software documentation

What's the best software for writing and publishing software documentation?
posted by four panels on Jan 31, 2007 - 10 answers

ISO Excellent/Innovative/Efficient/Fast/Cheap Document Management Software

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 - 9 answers

How do I reorder visio pages in a long document?

How do I quickly reorder (multiple) pages in a very long visio document? [more inside]
posted by mdiskin on Nov 1, 2006 - 2 answers

Does my name remain the same?

Have I successfully changed my name? [more inside]
posted by TG_Plackenfatz on Sep 5, 2006 - 20 answers

The programming is insubstantial, Catsby.

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 - 18 answers

got any mod_python and cheetah resources?

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 - 2 answers

Extracting XML schema documentation into lovely documentation

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 - 2 answers

how to make online docs efficiently?

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 - 10 answers

Page: 1 2
Posts