What's your preferred method of 3D model assembly instructions?
I am working on a new project, and it's going to be the most complex I have done so far.
If/when I post the model I am debating how to post the assembly instructions.
What do you guys prefer when building for the first time? Pictures? PDF's? Videos? Or does it even matter.
I'm not too keen on video... unless it's completely exported from Fusion. I'm not sure but I guess Printables can upload an instruction sheet pdf file?
I've done text, I've done different formats of pictures... I need to lock down a standard going forward, I guess. I don't know the first thing about youtube or whatever, so videos are kinda... eh.
Vehemently against AI. I've seen that film. It ends badly.
RE: What's your preferred method of 3D model assembly instructions?
I don't have the patience for videos. Nice clean pdf with pictures is my favorite, or html if you can do it. The way Prusa does their Core One assembly "manual" works well.
RE: What's your preferred method of 3D model assembly instructions?
Add my vote for PDF with pictures. They will make editing easier for you, too.
It very much depends on the build and on the intended builder - but I usually end up with HTML illustrated with both still pictures and very short videos ... and both the assembly and the instructions should be tested. Sometimes the instructions take longer to write and test than the original design process.
I first test myself and then sometimes give a finished version to someone else to test - iterate the design until satisfactory for other users. Then write a first draft of the instructions with still pictures, a wordprocessor will do; print a set of parts then watch someone build the project from your instructions - DON'T help them, just watch. Refine the instructions and maybe make one or two short videos (15 seconds to one minute) to demonstrate tricky points - retest until the instructions are good enough for a new builder to get it right most of the time
Finally convert the instructions to whichever format(s) are appropriate, as I wrote above, I usually produce HTML.
Cheerio,
RE: What's your preferred method of 3D model assembly instructions?
For the Core One kit I have used the step-by-step HTML pages while building, but have later referred back to the PDF multiple times since it is easily searchable. For other kits and repairs, I have happily followed a PDF with pictures right away. So if you want to limit the effort of creating instructions, PDF with pictures is fine.
Short videos (< 1 minute) which show particularly tricky assembly steps work for me, as a complement to written instructions and pictures. But long videos showing a complete assembly or repair process are not for me. I want to be able to search and move around (both to preview and to look back) in a document, not be paced by a linear instruction video.
A single standard is unlikely to suit everything - unless it is a huge compendium of related alternatives.
Consider:
A project that although complex overall can be broken to small, localised steps that can be detailed sufficiently on a mobile 'phone.
A project that is logically large enough that construction requires simultaneous attention to several non adjacent details which, to be represented legibly require a display too big for a phone but fine on a large monitor or printed page. The Christmas before last an rc robot toy came semi-assembled in parts with a printed sheet of a3 paper - place the parts on the paper in marked positions then lower the chassis onto them and screw together; a clever technique I haven't used yet but which is now in my arsenal.
A hybrid project, not just 3D printing but also mechanical, electronic and structural requiring metalworking, soldering, woodworking and fibreglass layup; yes I do deal with a few boatbuilders...
A project that is not intended to be built immediately but stored compactly in parts for an indefinite period until needed and then assembled, perhaps in a place without 'net or cell access.
In many cases a simple text with diagrams that can be read from a 'phone screen will suffice or maybe a dedicated app; they are easy to write nowadays. In the last case a printout packed with the parts might be the best option. But if you need large diagrams and either large format layouts or zoomable images then HTML is almost always going to be best, especially if video clips are also required. HTML has the advantage that is is readable on a wide variety of devices.
Some of the contents may usefully be standardised even if not all are required for every project:
A list of required resources, both printed and sourced elsewhere.
Printing instructions where not standard.
Checkpoints and tests at intermediate stages. How do I know I got it right so far?
Suggestions for optimal usage and later maintenance.
Here's an example of the sort of instructions I'm suggesting from a few years ago before I gave up on Printables as a waste of time:
https://www.printables.com/model/255791-basic-walker-walking-construction-toy
Cheerio,
RE: What's your preferred method of 3D model assembly instructions?
Not everyone will have access to a computer to watch videos during assembly. Something that can be printed is very useful. I voted for PDF.
Some prefer videos. Build document in LibreOffice, export as HTML and PDF. Can still have links to videos in the document.
RE: What's your preferred method of 3D model assembly instructions?
might be too technical but for example (and don't laugh) but that lego app that lets you download the 3D build instructions so you can rotate things nad see how it goes through.
But in general, depending on the project, something with various pictures showing how it goes together and if something is tricky to assemble a link to a short video showing how to do that step is helpful for me
Shane (AKA FromPrusa)
RE:
If your audience is engineers or technical folk, it won't matter that much and annotated diagrams are fine.
If you expect it to made by random people, you need a PDF with photos of actual printed parts being assembled, or you need a video of the same, and should ideally have both. I learned this from assisting at a nerf club where 3d printed blasters were common. You would not believe how many people do not know how to drive a screw into plastic without stripping the threads from the plastic.
Then again, you don't need any of this stuff really as free model = no complaining!
edit It's possible i am misunderstanding as i dont know what your model is. If it's NOT fucntional and just like a complex 3d jigsaw, maybe you don't need a video. But if it's functional then you need to tell people how to drive screws, or a put a pinion onto a motor without knocking the shaft out of alignment etc.
RE:
I do mostly hobby/collector based models. Making add-ons or models that aren't currently available. So I will probably keep it simple. I am planning a PDF instruction file. That will work for Printables. I don't know about Thingiverse or other sites, though. If I have to, I can always screen print it and make it photo based after the fact.
I've thought about getting into Youtube... Making little shorts or something on my models. But I don't have the right gear and don't care enough.
Vehemently against AI. I've seen that film. It ends badly.
RE: What's your preferred method of 3D model assembly instructions?
The problem with instructions is you already know how to do it. Leaving out little things is something to check for. Before release have someone else review it.
Pictures are worth a thousand words. If there are too many words, think of how to add or edit the pictures to be clear. Add arrows, circles and pointers in the pictures to point out details. If parts are black or dark, have light backgrounds in the pictures. Use a sheet or something to make a photo backdrop. Take extra pictures, you may need them as you build the instructions. I also edit the pictures for size. I reduce most to a width of 800 to 1500 pixels. This keeps the document from becoming huge and keeps it easy to print.
Videos are good if you have the means to edit, add pictures and so on. In many cases it takes longer to produce the video correctly than doing step by step pictures. I find with videos I have to pause and rewind a lot. Avoid going on and on for no real reason, as a popular video site has made common.
In the end I prefer good, step by step instructions with pictures.
I've thought about getting into Youtube... Making little shorts or something on my models. But I don't have the right gear and don't care enough.
I you just have a tricky step to illustrate within a text youtube isn't necessary - up to 15 seconds or so streaming is rather inefficient; just link to a video file, mp4 will do or webm, and have the client download and run it natively. It doesn't need to be sophisticated, record a few takes then choose the most suitable and the only editing will be trimming to the best start and end points.
Here's an example from the link above showing how to free a particular bearing:
http://www.half-baked-idea.co.uk/3d/walker/images/pb.mp4
- If I was doing it again now I would probably put it on a secure server but I don't think there is any way to incorporate malware into such a short mp4 clip (and secure sites can be run by the bad guys too.)
Cheerio,
RE:
One of my models - the protean "nerf" (foam) blaster select fire mod using an arduino - absolutely needs a video to explain how to wire the circuit, use the arduino programmer, and modify the code to adjust the firing paramaters. I have only provided a rather cursed circuit diagram which is a photo with lines drawn.
One of my other models, the Dragontrack RC, surely needs a video to explain the machinist skills needed to assemble it, however its hardware requirement is enough that I think only a technical type would try to build it, so maybe it's OK.
I really do need to make videos, but they're free models and I don't want or need to make a profit off them. Otherwise I would sell the dragontrack files on Cults3d with a video to go with it, or I would talk to MMF about getting sales figures for Youmagine. (edit Most of the good paid RC stuff is on Cults3d).
RE: What's your preferred method of 3D model assembly instructions?
Some people will not use videos. Some as Diem says won't use text. For many things, I need to use printed documentation since there is no network connections where I do many things. Cellphone access is also almost zero.
There are so many different levels of users out there, that you need to cover most of your "customers". In one job, any instructions had to be written as if a 5yr old was going to follow them. This was for adults. From my experience, this was a good lesson. I personally hate video instructions. I have downloaded many over the years and found that, for me, they are hard to follow and in some cases. created extra work since they were not available where I was working and required changing buildings to watch them.
Not everyone has or will take the time to make it possible to watch a video where it is needed. So, depending on what you are trying to make instructions for, think of where people might need to use them. Basement, garage, parking pad, etc. Again, think as if you are a kid doing the job and zero knowledge of the project. Having a non-technical person review the documentation is a great suggestion.
Animate GIF images can be embedded into some documents. That may work.
If you are doing mechanical drawings, you can explode the parts in a diagram. I have done this in FreeCAD with Assembly 4 for some people.
In contrast to public-username-required, I have seen many Arduino projects where diagrams, code and assembly worked perfectly in a printed document. Many using Fritzing to generate their breadboard diagrams for the electronics. I do agree again with public-username-required, some people cannot follow a diagram and need simple, single step instructions which are easy in a stop motion video. In printable documentation, it just means more words and images. A video is just a collection of stop motion frames.
RE:
The last model I made, this one https://www.printables.com/model/1595810-velguarder-from-rockman-x-kotobukiya-scale I used a picture based instructions.
I am trying to designate my parts like they are on a model runner and write the instructions accordingly like your putting together a model kit. A video would be useful for marketing, but since I don't charge for my stuff and don't really need to spend $40 on shipping free filament, meh. Whatever.
One little bug I have found on the internet is sometimes the pictures just turn out blurry due to preview and resolutions when you open them...
Vehemently against AI. I've seen that film. It ends badly.
so I can see exactly how the parts fit together without too much reading.
In one sense I agree, that's fine as long as it is just a simple fit-the-bits-together process but many larger projects are more complex than that especially when non printed parts are also involved. Even a simple parametric component might involve several measurements and settings which must be explained before slicing...
Cheerio,
I used a picture based instructions.
I am trying to designate my parts like they are on a model runner and write the instructions accordingly like your putting together a model kit.
Not my sort of design but no matter. Please read this as constructive criticism.
The trouble is that as presented your instructions are dense and may be offputting for any but the most dedicated.
Because the pictures are separate from the text the builder must refer backwards and forwards many times - if you duplicate the pictures within the text so the instruction and illustration are adjacent it greatly reduces the load on the builder - perhaps copy the technique used in the example I linked early in this thread.
In several places you say "do not over-tighten or under tighten the lock." without indicating how tight is correct: eg., "tighten the lock until it does not move when gently shaken but can be repositioned by light finger pressure" - would (if correct) be more understandable.
sometimes the pictures just turn out blurry due to preview and resolutions when you open them...
This happens when the website uses a standard size for previews/thumbnails. Check the size they use, your browser should tell you in pixels, then make your detailed uploads a multiple of this size, eg. for Printables 320x240 format you might choose to upload at 960x720 giving enough detail when expanded but a simple division so that the preview doesn't have to chop and approximate pixels.
-and as this is a 3D visualisation of an existing work you should give some indication of the copyright status with reference to the original.
Cheerio,
RE: What's your preferred method of 3D model assembly instructions?
Noted. I'll keep that in mind when I write the next one.
Vehemently against AI. I've seen that film. It ends badly.
RE: What's your preferred method of 3D model assembly instructions?
I am trying to designate my parts like they are on a model runner and write the instructions accordingly like your putting together a model kit. A video would be useful for marketing, but since I don't charge for my stuff and don't really need to spend $40 on shipping free filament, meh. Whatever.
If it's a model kit, you already know the answer. Most of them come with picture instructions, and people have grown accustomed to that.
RE:
Forgot to add to my previous message, regarding your redeeen of points for filament coupons for your model kit, I assume you're well aware that there are sites for paid models like this that people make professional livings out of, but they have to contend with copyright issues. The rights holders are generally less strict about free models. I would say though, that full self-assemble kits are uncommon; typically a figure like this would be resin printed and then hand-painted, the number of parts would be based on model topology or optional poses, not the assembly experience.